Zendesk API 管理员指南

Zendesk API 是什么？

API（即应用程序编程接口）是一种供软件应用程序使用的工具。想象一下一家餐厅，服务生将盘子从厨房端到您的座位上。API 的工作方式类似：它将数据从一个点带到另一个点。在 API 中，盘子称为 资源，而为您提供服务的服务器称为 端点。想象一下您在餐厅可能会点的一盘菜。有些端点会带回一系列项目，例如试用拼盘。API 中的一个例子是 List Users 端点。返回您 Zendesk Support 帐户中 所有 用户的列表。某些端点（例如显示用户端点）更具针对性，仅返回单个内容。

您还可以使用 API 更改 Zendesk 中的内容。想象一下，告诉服务生您的排骨想怎样吃会怎样。实际操作过程中，主厨会根据您的喜好更改牛 排。API 是一个强大的资源，我们的许多客户都用来批量导入资源、创建应用、提取数据到外部源。

大多数 Zendesk API 的参考文档都可以在 Zendesk 开发者门户的 API 参考部分找到。参考文档描述了所有可用的端点。 您也可以从 Zendesk 开发者指南 开始。虽然文档很全面，但我们将在这篇文章中讨论如何解码和使用它们。

为什么使用 API？

现在您知道了什么是 API，可能会想：“我为什么要关心它？”简而言之，您可以使用 API 添加用户界面中不可用的功能（无论是原生还是在您的服务模式级别），添加速度比手动添加快得多。

对于当前使用 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- 创建前所未有的项目
• PUT- 更新现有项目
• 删除 - 移除项目

在浏览器中，您只能发出 GET 请求。您可以使用 cURL 或 Postman等工具执行其他操作。

cURL

参考文档在所有端点示例中都使用了 cURL。 cURL 是一个命令行工具，使您无需浏览器即可尝试 API 命令。有关更多信息，请参阅 Zendesk 帮助中心的 安装和使用 cURL。您可以将 cURL 用于 4 种类型的通话中的任意一种。Mac 上已预装，但在 Windows 中需要安装。如需相关说明，请参阅 Zendesk 帮助中心的 安装 cURL。

您请求的状态

对于您提出的每个 API 请求，您都会收到一条响应，告知您是否有效。如果没有，响应将说明请求无效的原因。这些响应称为 状态代码。一些基本规则如下：

• 200 - 请求成功
• 400-请求未成功
• 409——合并或限制错误，请再次尝试调用
• 422 -无法处理的实体
• 429——超出速率限制
• 500 - 警告或临时状态，如果问题持续存在，请联系支持人员

有关状态代码的更多详情，请参阅 API 文档中的 响应格式 。

练习

现在我们已了解了 API 的基础知识，接下来实际使用它来搜索工单。

假设我是团队级别服务模式的用户，我一直在使用工单标签来跟踪工单升级到不同支持级别的时间。我添加的工单标签是 escalation_one 和 escalation_ Two。

现在，我想为系统中遇到两次升级的每张工单生成一份报告。我尝试创建一个视图以退回这些工单，但这无法满足我的需求，因为已存档工单未显示。现在该怎么办？

答案：使用 API 获取工单！

要进行此操作，您需要查看 搜索 API 端点。此端点 不会 筛选出已存档工单，因此您可以用它来返回所有包含这两个标签的工单列表。同样，Search API 是一个简单的 GET 调用，如果您已在浏览器的另一个标签页上登录 Zendesk Support，就可以直接在浏览器中使用它。Search 端点的格式如下：

subdomain.zendesk.com/api/v2/search.json?query={search_string}

重要提示：务必将“子域名”替换为您的帐户子域名。

搜索 API 非常灵活，可以使用 Zendesk 搜索参考中概述的任何内容进行查询。在我们的例子中，因为我们只是在寻找标签，所以在搜索字符串中使用的唯一参数是“tags”。要搜索多个标签，只需在“tags”参数后的标签之间添加逗号即可。现在您的通话应如下所示：

https://subdomain.zendesk.com/api/v2/search.json?query=tags:escalation_one,escalation_two

要对请求进行身份验证，请确保您是专员或管理员，并已在浏览器的其他标签页中登录 Zendesk Support。

在浏览器中运行此调用将返回带有 这两个 标签的工单列表。然后您可以保存 JSON 输出以供将来使用。

恭喜！您已阅读最后！API 是一款功能强大、用途广泛的工具。在这里，您可以进一步深入研究参考文档和 Zendesk 开发者文档。

翻译免责声明：本文章使用自动翻译软件翻译，以便您了解基本内容。 我们已采取合理措施提供准确翻译，但不保证翻译准确性

如对翻译准确性有任何疑问，请以文章的英语版本为准。