什么是 Zendesk API?
API,即应用程序编程接口,是用于软件应用程序的工具。如果您想起了餐厅,那么服务员就会从餐厅里把盘子端到您的桌前。API 的工作方式与之类似:它将数据从一个点转移到另一个点。在 API 中,盘子称为" 资源",将它送到您的服务者称为" 端点"。想一个您可能在餐厅要的特定食物。一些端点会返回项目集合,如采样器盘。API 中的一个例子是 列表用户端点。它会返回您 Zendesk Support 帐户中的 所有 用户列表。一些端点如显示用户端点更专注,只返回一个内容。
您也可以使用 API 更改 Zendesk 中的内容。想象一下,告诉一个服务者您希望怎样把您的食物做好。大夫实际会根据您的喜好进行更改。API 是一个强大的资源,我们的许多客户用来批量导入资源、创建应用、提取数据到外部源以及更多。
Zendesk API 的大多数参考文档都可在 Zendesk 开发者门户的 API 参考部分。参考文档描述了所有可用的端点。 您也可以使用 Zendesk 开发者指南 开始。虽然文档是全面的,但我们将在这篇文章中介绍如何进行编码和使用。
为什么使用 API?
既然您已了解什么是 API,您可能会想知道:"我为什么要在乎这些?" 简而言之,您可使用 API 添加在 UI 中不可用的功能(原生或在您的服务模式级别),其速度比尝试手动添加要快得多。
对于当前使用 Essential 或 Team 服务模式的帐户,使用 API 使您有一个导出数据的直接方法,无需升级到 Professional(可自动导出数据)。类似地,您可使用 API 获取工单数据,以用于报告目的。API 可返回与工单有关的所有信息,因此您可使用 API 输出将数据传递到第三方报告应用程序。
快速更新多条记录的功能是使用 API 的另一个优势。例如,虽然您一次只能在专员界面中创建一个组织,但您可以使用 API 一次创建最多 100 个组织。与此同时,对于您一次可以更新多少个项目的限制,对于 API 的限制更高。界面允许一次编辑 60 张工单,而 API 允许最多 100 张工单。
其它常见任务包括:
- 创建工单
- 从另一个系统迁移工单数据到 Zendesk
- 批量编辑用户
- 正在搜索记录
- 以及更多!
现在我们已概述了您为什么要使用 API 的原因,让我们来看看如何提交 API 请求。
格式
Zendesk API 以称为 JSON 的轻量格式返回数据。请在 Zendesk 帮助中心里 使用 JSON。您可以通过安装适用于Chrome或 Firefox的 JSON 查看器功能扩展,在网络浏览器中查看格式化数据。
JSON 是这样的:
{
"posts": [
{
"id": 35467,
"title": "How do I open the safe"
},
{
"id": 35468,
"title": "How do I reset the combination?"
},
]
}
一个通常的端点是这样的:
subdomain.zendesk.com/api/v2/users/me.json
端点可以执行以下操作:
- GET- 检索项目
- POST- 创建之前不存在的项目
- PAT- 更新现有的项目
- 删除 - 移除项目
在浏览器中,您只能发送 GET 请求。您可以使用 cURL 或 postman等工具执行其它操作。
cURL
参考文档在所有端点范例中都使用了 cURL。 cURL 是一个命令行工具,使您可以在没有浏览器的情况下尝试 API 地址。有关更多信息,请查阅 Zendesk 帮助中心里的" 安装和使用 cURL"。您可以将 cURL 用于 4 种呼叫类型中的任意一种。它已预安装在 Mac 上,但您需要在 Windows 中安装。有关说明,请参阅 Zendesk 帮助中心里的" 安装 cURL"。
您请求的状态
对于您提交的每个 API 请求,您都会收到一个回复,让您知道其是否有效。如果不是这样,则回复将提供关于为什么请求无效的原因。这些响应称为 状态代码。一些基本的设置如下:
- 200 —— 请求成功
- 400 —— 请求未成功
- 409 —— 合并或限制错误,再试一次通话
- 422 —— 无法处理实体
- 429 —— 已超出速率限制
- 500 —— 警告或临时状态,如果继续出现,请联系支持人员
如需了解更多关于状态代码的详情,请在 API 文档中查看 响应格式 。
实践
现在我们已完成了 API 的基础知识,让我们实际用它来搜索工单。
比如说,我是 Team 级别服务模式的用户,我一直在使用标签来跟踪何时工单逐步升级到不同的支持级别。我添加的标签是 ecalcation_one 和 ecalcation_2。
现在,我想要为我的系统中的每张工单生成一份报告,其中的每张工单都已达到了逐步升级的状态。我尝试创建一个视图以返回这些工单,但这无法满足我的需求,因为已存档工单未显示。现在我该怎么做?
答案:使用 API 获取工单!
要进行此操作,您需要看看 Search API 端点。此端点 不会 筛选已存档工单,因此您可以用它返回包含这两个标签的所有工单列表。类似地,搜索 API 是一个简单的 GET 调用,因此如果您在浏览器的另一个标签上登录 Zendesk Support,则可以直接在浏览器中使用它。Search 端点的格式如下:
subdomain.zendesk.com/api/v2/search.json?query={search_string}
重要:请确保将"子域名"替换为您帐户的子域名。
搜索 API 非常灵活,查询可使用 Zendesk 搜索参考中概述的任何内容。在我们的例子中,由于我们只是查找标签,我们将在搜索字符串中使用的唯一参数是"标签"。要搜索多个标签,只需在"标签"参数之后在标签之间添加一个逗号。现在您的电话应是这样的:
https://subdomain.zendesk.com/api/v2/search.json?query=tags:escalation_one,escalation_two
要对请求进行身份验证,请确保您是专员或管理员,并且您已在浏览器的另一个标签上登录 Zendesk Support。
在您的浏览器中运行此调用将返回带有 这两个 标签的工单列表。然后您可以保存 JSON 输出以供今后使用。
恭喜!您已成功完成!API 是一个强大的工具,有很多用途。从这里您可以开始深入研究参考文档和 Zendesk 开发者文档。
翻译免责声明:本文章使用自动翻译软件翻译,以便您了解基本内容。 我们已采取合理措施提供准确翻译,但不保证翻译准确性
如对翻译准确性有任何疑问,请以文章的英语版本为准。