请求

请求格式

Zend亚博esk API是一个JSON API。你必须提供内容类型:application / json头在PUT, POST和DELETE请求。你必须设置一个接受:application / json所有请求的头。你五月得到一个文本/平原在错误的情况下响应，如一个坏的请求。您应该将此视为需要修复的错误。

这个API的JSON属性是区分大小写的。例如，下面的POST到api / v2 / tickets.json不会起作用，因为身体大写:

             

              
｛“票”：｛“主题”：“我的打印机着火了!”,“评论”：｛“身体”：“烟的颜色很鲜艳。”｝｝｝
             

要了解更多信息，请参见使用JSON．

响应格式

Zend亚博esk API用200或300范围内的HTTP状态码响应成功的请求。当您创建或更新资源时，API将在响应体中呈现结果JSON表示，并可以设置位置头指向资源。例子:

             

              
状态:201已创建地点:https://{子域名}.zendesk.com/a亚博pi/v2/items/123.json｛"项目":{“id”:123年,“url”:“https://{子域名}.zendesk亚博.com/api/v2/items/123.json”,“名称”:“Wibble”,…“created_at”:“2012 - 04 - 04 - t09:14:57z”｝｝
             

时间戳使用UTC时间，其格式为ISO 8601．

响应还包括以下报头，指示帐户的当前速率限制和当前分钟内剩余的请求数:

             

              
X-Rate-Limit:700X-Rate-Limit-Remaining:699
             

API用400范围内的HTTP状态码响应不成功的请求。看到400范围．

状态码

响应可能具有以下部分中描述的状态代码。

200范围

请求成功。成功的GET和PUT请求的状态为200，大多数POST请求的状态为201,DELETE请求的状态为204。

400范围

请求没有成功。响应的内容类型可以是文本/平原用于API级别的错误消息，例如试图在没有SSL的情况下调用API。内容类型为application / json用于业务级别的错误消息，因为响应包含一个JSON对象，其中包含关于错误的信息:

             

              
｛“细节”：｛“价值”：［｛“类型”：“空白”,“描述”："不能是空白"｝,｛“类型”：“无效”,“描述”：“格式不正确”｝］｝,“描述”：“RecordValidation错误”,“错误”：“RecordInvalid”｝
             

如果您看到来自已知端点的响应看起来像纯文本，那么您可能在请求中犯了语法错误。这种类型的响应通常发生在向不存在的Zendesk Support实例发出请求时。亚博

403

403响应表示服务器已经确定用户或帐户不具有使用API所需的权限。

409

409响应可能表示合并冲突，但它通常表示数据库中由于试图同时创建资源而导致的唯一性约束错误。再次尝试API调用。

一般来说，Zendesk API亚博可以处理并发API请求，但这些请求不应该涉及相同的资源，例如同一个请求者。亚博电脑端尽可能序列化请求。

422不可处理实体

422响应意味着请求实体的内容类型和语法是正确的，但是服务器不能处理内容本身。这通常是由于请求实体与它试图创建或更新的资源不相关。示例:试图关闭一个已经关闭的票证。

429

429错误表示超过了使用限制。看到速度限制．

500范围

如果您曾经遇到状态码在500范围内的响应，则API可能遇到内部问题或正在进行计划维护，在此期间您可能会收到一个错误503业务不可用状态码。

一个503的回答Retry-After头指示数据库超时或死锁。属性中指定的秒数后重试请求Retry-After头。

如果503响应没有Retry-After头，Zendes亚博k支持可能遇到内部问题或正在进行定期维护。在这种情况下，检查@亚博zendeskops和我们的状态页任何已知的问题。

在构建API客户端时，我们建议将任何500个状态代码视为警告或临时状态。但是，如果状态持续，并且我们没有公开宣布维护或服务中断，请通过亚博Zendesk客户支持．

如果向Zendesk提交票据，请提供亚博X-亚博Zendesk-Request-Id头包含在HTTP响应中。这有助于支持团队更快地在日志中跟踪请求。