介绍
这是Zendesk支持API(也称为票务API)的参考文档。亚博您可以对票证、用户和组织使用Support API,并管理票证工作流。
任何通用机制和约定(如分页和身份验证)都按照亚博Zendesk API介绍并被认为隐含在这篇文章中。
除了参考文档,以下资源是可用的:亚博电脑端
邮差跑进来
如果你使用Postman,你可以将Support API端点作为一个集合导入到你的Postman应用程序中,然后尝试不同的请求来了解API是如何工作的。点击以下按钮开始:
如果你不使用邮差,你可以注册一个免费帐户邮递员的网站下载应用程序。
文档约定
有关文档中使用的语法和样式约定的信息,请参见文档约定在通用API介绍中。
例子
有关文档中示例的信息,请参见例子在通用API介绍中。
安全性和身份验证
有关使用API所需的身份验证的信息,请参见安全性和身份验证在通用API介绍中。
速度限制
有关每分钟允许的请求数的信息,请参见速度限制在通用API介绍中。
请求格式
有关请求的信息,请参见请求在通用API介绍中。
响应格式
有关API返回的HTTP状态码的信息,请参见响应格式在通用API介绍中。
幂等性
票务API允许您指定一个幂等性键,该键允许您重试票证创建请求,而不会有创建重复记录的风险。
要指定一个等幂键,请提供Idempotency-Key: {unique_key}
头包含您的请求。
例子:
旋度https://{子域名}。亚博。com/api/v2/票。json \
-d{"ticket": {"subject": "打印机脱机",\
"comment": {"body": "My printer is offline. "重启并没有帮助。””}}}\
-H“application / json内容类型:-H“Idempotency-Key: 12345”\
-v-你的用户:密码-X帖子
这将创建以下响应,其中还包括一个x-idempotency-lookup:小姐
标题:
状态201创建
{
“票”:{
“url”:“https://{子域名}.zendes亚博k.com/api/v2/tickets/3.json”,
“id”:3.,
“主题”:“打印机脱机”,
…
}
}
如果使用相同的主体和幂等键重复相同的请求,则不会创建另一个票证。相反,您将得到与之前相同的响应,该响应缓存在幂等键下。这次的响应包括一个x-idempotency-lookup:打
标题:
状态201创建
{
“票”:{
“url”:“https://{子域名}.zendes亚博k.com/api/v2/tickets/3.json”,
“id”:3.,
“主题”:“打印机脱机”,
…
}
}
如果你用相同的等幂键创建一个请求,但是用不同的主体,你会收到以下错误:
400坏请求:
{
“错误”:“IdempotentRequestError”,
“描述”:"请求参数与给定的等幂键不匹配"
}
密钥在两小时后失效。如果在原始请求发出两小时后发送带有重复密钥的请求,则该请求将创建一个新票证。
等幂键不存储为票证响应的一部分。打开机票时,您将看不到钥匙。
数据类型
有关API中使用的数据类型的信息,请参见数据类型在通用API介绍中。
分页
有关通过列表端点分页的信息,请参见分页在通用API介绍中。
法律声明
您使用和访问API的明确条件是,您必须遵守我们的网站中所载的与API相关的政策、限制和其他规定API限制和职责,在我们的改变政策,以及我们提供给您的其他文档。您还必须遵守在亚博Zendesk主订阅协议和亚博Zendesk隐私政策,在API的所有使用中。如果Z亚博endesk认为您已经或试图违反这些政策或协议的任何条款、条件或精神,您访问和使用API的权利可能会被暂时或永久撤销。