这是Zendesk集成服务(ZIS) api的参考文档。亚博它记录了可以用于使用ZIS构建和运行集成的REST api。ZIS api支持对话式数据编排。

ZIS api可在Suite Growth及以上版本和Support Professional及以上版本上使用。如果您有兴趣成为Zendesk开发人员合作伙伴,可以将试用帐户转换为赞亚博助Zendesk帐户。看到获得开发的试用或赞助帐户

文档约定

有关所使用的语法和样式约定的信息,请参见文档约定在通用API介绍中。

例子

有关api中使用的curl示例的信息,请参见例子在通用API介绍中。

安全性和身份验证

除非另有说明,ZIS api使用OAuth 2.0对请求进行身份验证。OAuth访问令牌必须与请求中指定的ZIS集成相关联。要获得此令牌,请参见获取一个ZIS OAuth令牌

一些端点支持其他身份验证方法,包括:

  • 基本身份验证
  • API的令牌
  • Zendesk应用中的浏览器会话认证亚博

如果支持,这些身份验证方法将在端点的文档中注明。有关基本身份验证和API令牌的详细信息,请参见安全性和身份验证在通用API介绍中。有关浏览器会话身份验证的详细信息,请参见从Zendesk应用程序发出API请求亚博

速度限制

以下API速率限制适用:

如果超过速率限制,API将响应HTTP 429太多请求状态码。

有关每分钟允许的请求数的详细信息,请参见速度限制在通用API介绍中。

请求格式

有关JSON请求格式的信息,请参见请求格式在通用API介绍中。

响应格式

有关这些api返回的HTTP状态码的信息,请参见响应格式在通用API介绍中。

分页

有关在列表端点之间分页的信息,请参见分页在通用API介绍中。

数据类型

有关api返回的数据类型的信息,请参见数据类型在通用API介绍中。