搜索zookal / zendesk
Zendesk Magento 扩展
Requires
This package is not auto-updated.
Last update: 2020-08-22 07:17:52 UTC
README
此扩展使 Zendesk 与 Magento 无缝集成，使商店能够提供卓越的客户支持。主要功能包括：
- 启用与 Zendesk 的单点登录
- 无需离开 Magento 创建支持票证
- 在订单和客户仪表板上显示相关的支持票证
- 从“联系我们”请求中创建支持票证
- 轻松将反馈选项卡添加到您的网站
最新稳定版本的扩展可以通过 Magento Connect 市场安装。
API
一般说明
该扩展提供自己的自定义 RESTful API，旨在由 Magento Zendesk App 使用。自定义 API 允许在不同版本的 Magento 之间保持一致的用户界面，无论它们是否支持 XML-RPC、SOAP 或 REST 接口，并提供应用程序所需的确切数据。
API 的基本 URL 是 http://your_site_base_url/zendesk/api/。
认证
可以在 Magento 管理面板中的 Zendesk 设置页面启用 API。使用它需要生成令牌并将其发送到 API 的 Authorization 标头中。
Authorization: Token token="your token goes here"
单点登录 (SSO)
-
管理员与代理
远程登录 URL: http://your_site_base_url/admin/zendesk/authenticate 远程登出 URL: http://your_site_base_url/admin/zendesk/logout
-
最终用户
远程登录 URL: http://your_site_base_url/zendesk/sso/login 远程登出 URL: http://your_site_base_url/zendesk/sso/logout
响应
您可能从任何 API 调用中收到以下错误
-
401 未授权
认证令牌无效。
-
403 API 访问已禁用
在 Magento 管理面板中已禁用 API 访问。在使用 API 之前需要启用。
-
404 资源不存在
找不到请求的资源。
所有 API 方法都返回 JSON 对象的内容，格式如下面的方法定义所示。
可用方法
GET /customers/<email>
将返回具有提供的电子邮件地址的客户的客户信息。如果没有找到客户记录但有订单已下，则电子邮件被视为访客，并且仅返回他们下过的订单。如果没有找到客户记录且没有使用电子邮件的订单，则返回 404 错误。
注意，Magento 允许按全局或按网站对客户进行范围限定。如果设置为按网站限定，则此方法将返回与电子邮件地址匹配的第一个客户，无论他们属于哪个网站。
响应格式
仅访客客户返回 guest 和 orders 键。
| 名称 | 类型 | 注释 |
|---|---|---|
| guest | 布尔值 | 客户是访客（没有客户记录）还是拥有完整的客户记录 |
| id | 整数 | 内部 Magento 客户 ID |
| name | 字符串 | 客户的完整姓名 |
| 字符串 | 客户的电子邮件地址 | |
| active | 布尔值 | 客户是否在 Magento 中标记为活动状态 |
| admin_url | 字符串 | 访问 Magento 管理面板中客户详情的 URL |
| created | 字符串 | 客户记录创建的日期和时间 |
| dob | 字符串 | 出生日期 |
| addresses | 数组 | 客户账户上记录的地址列表 |
| orders | 数组 | 客户下订单的列表（详细信息请参阅 `orders` 方法） |
GET /orders/<order_increment_id>
根据 Magento 订单增量 ID 返回单个订单的详细信息，通常形式为 100000321。
响应格式
| 名称 | 类型 | 注释 |
|---|---|---|
| id | 字符串 | 显示给客户的订单 ID |
| status | 字符串 | 当前订单状态（例如：待处理、处理中、完成） |
| created | 字符串 | 订单创建的日期和时间 |
| updated | 字符串 | 订单最后更新的日期和时间 |
| customer | 对象 | 具有以下键
|
| store | 字符串 | 下单时的 Magento 店铺 |
| total | 字符串 | 订单的总价值 |
| currency | 字符串 | 货币代码（例如：AUD、USD） |
| items | 数组 | 订单上的商品列表；每个商品具有以下键
|
| admin_url | 字符串 | 访问 Magento 管理面板中订单的 URL |
GET /users/<user_id>
如果省略了 user_id 参数，则返回单个 Magento 管理用户，或者返回用户列表。管理员账户可以访问管理面板，与客户账户不同。
参数
| 参数 | 默认值 | 注释 |
|---|---|---|
| page_size | 100 | 要返回的结果数量 |
| offset | 0 | 要返回的页面编号，基于 `page_size` |
| sort | given_name | 排序的属性 |
响应格式
| 名称 | 类型 | 注释 |
|---|---|---|
| id | 字符串 | 用户的内部 ID |
| given_name | 字符串 | 用户名 |
| family_name | 字符串 | 用户姓 |
| username | 字符串 | 用于登录 Magento 管理面板的用户名 |
| 字符串 | 用户电子邮件地址 | |
| active | 布尔值 | 用户是否启用并可登录 |
| role | 字符串 | 用户角色；用于 Magento 的 ACL |
本地开发
重置扩展
在开发过程中，您可能希望清除 Magento 扩展的配置。所有设置都存储在 Magento 数据库的 core_config_data 表中，可以使用 SQL 查询将其删除
DELETE FROM `core_config_data` WHERE `path` LIKE 'zendesk/%';
贡献
扩展的改进总是受欢迎的。要贡献，请提交详细的 Pull Requests。
错误
请将错误报告提交到 Zendesk。
版权和许可
版权所有 2012，Zendesk Inc。根据Apache许可证第2版授权。