Zendesk API是亚博什么?
API或应用程序编程接口是软件应用程序的工具。如果你想到一家餐馆,服务员把菜从厨房端到你的桌子上。API以类似的方式工作:它将数据从一个点传输到另一个点。在API中,这道菜被称为a资源给你端菜的服务员叫“安”端点。想想你可能会在餐厅点的一道菜。有些端点会为您带回一系列项目,例如采样盘。API中的一个示例是列表用户端点。它返回一个列表所有用户在您的Zendesk支持亚博帐户。一些端点,比如显示用户端点更专注,只返回一个东西。
您还可以使用API对Zendesk中的内容进行更改。亚博想象一下,告诉服务员你的牛排要怎么做。厨师会根据你的口味来做牛排。该API是一个强大的资源,我们的许多客户都使用它来批量导入资源、创建应用程序、将数据拉到外部数据源等等。亚博电脑端
Zendesk API的大多数参考文档都可以在亚博API参考部分Zendesk亚博开发人员门户。参考文档描述了所有可用的端点。你也可以用亚博Zendesk开发者指南开始吧。虽然文档很全面,但我们将在本文中讨论如何解码和使用它们。
为什么要使用API?
现在您已经知道了API是什么,您可能想知道,“我为什么要关心这个?”简而言之,您可以使用API来添加UI中不可用的功能(无论是原生的还是在您的计划级别),速度比尝试手工完成要快得多。
对于当前处于Essential或Team计划中的帐户,使用API允许您直接导出数据,而无需升级到Professional(允许自动导出数据)。类似地,您可以使用API获取票据数据以进行报告。API可以返回与票据相关的所有信息,因此您可以使用API输出将数据传递给第三方报告应用程序。
快速更新许多记录的能力是使用API的另一个好处。例如,虽然您一次只能在代理接口中创建一个组织,但您可以使用API一次创建多达100个组织。同样,API对一次可以更新多少项的限制也更高。该接口允许一次编辑60张票,而API允许多达100张票。
其他常见任务包括:
- 创建门票
- 将票证数据从另一个系统迁移到Zendesk亚博
- 批量编辑用户
- 搜索记录
- 还有更多!
既然我们已经概述了为什么要使用API,那么让我们看看如何发出API请求。
格式
Zend亚博esk API以一种称为JSON的轻量级格式返回数据。看到使用JSON在Zendes亚博k帮助中心。您可以通过安装JSON查看器扩展来在web浏览器中查看格式化的数据铬或火狐。
JSON是这样的:
{"posts": [{"id": 35467, "title": "如何打开保险箱"},{"id": 35468, "title": "如何重置密码?"},]}
一个典型的端点是这样的:
subdomain.亚博zendesk.com/api/v2/users/me.json
端点可以执行以下操作:
- 得到-检索项目
- 帖子-创建以前不存在的项目
- 把-更新现有项目
- 删除-移除物品
在浏览器中,您只能发出GET请求。您可以使用cURL或邮递员。
旋度
参考文档在所有端点示例中都使用了cURL。cURL是一个命令行工具,它允许您在没有浏览器的情况下尝试API命令。有关更多信息,请参见安装和使用cURL在Zendes亚博k帮助中心。您可以对这4种类型的调用中的任何一种使用cURL。它预装在Mac电脑上,但你需要在Windows上安装。有关说明,请参阅安装旋度在Zendes亚博k帮助中心。
您的请求状态
对于您发出的每个API请求,您都会收到一个响应,让您知道它是否工作。如果没有,响应将提供请求失败原因的线索。这些反应被称为状态码。一些基本的方法如下:
- 200 -请求成功
- 请求不成功
- 合并或约束错误,请再试一次
- 422 -不可处理的实体
- 已超过速率限制
- 500 -警告或临时状态,如果仍然存在,请联系技术支持
看到响应格式有关状态码的更多详细信息,请参阅API文档。
实践
现在我们已经了解了API的基础知识,让我们实际使用它来搜索我们的门票。
假设我是团队级别计划的用户,我一直在使用标签来跟踪票据何时升级到不同的支持级别。我添加的标签是escalation_one和escalation_two。
现在,我想生成一个报告,其中包含我的系统中遇到过两个升级的所有票据。我试图使一个视图返回这些票,但这并没有满足我的需要,因为存档的票没有显示。我现在该怎么办?
答案:使用API获取门票!
要做到这一点,您需要检查搜索API端点。这个端点不过滤掉存档的票证,这样您就可以使用它来返回包含这两个标签的所有票证的列表。同样,搜索API是一个简单的GET调用,所以如果你在浏览器的另一个选项卡上登录到Zendesk Support,你可以直接在浏览器中使用它。亚博搜索端点的格式如下:
subdomain.亚博zendesk.com/api/v2/search.json ?查询= {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开发人员文档。
0评论
请登录留下评论。