文档约定

端点

端点用一个HTTP方法和一个路径来描述。例子:

             

              
得到/api/v2/help_center/在-我们/文章．json
             

.json扩展名是可选的。如果省略了它，则必须包含内容类型:application / json头在PUT, POST和DELETE请求。

预先添加Zendesk支持亚博URL到路径，以获得完整的端点URL。例如，如果您的支持URL是https ://obscura.亚博zendesk.com，然后使用以下端点URL:

             

              
https：//针孔．亚博．com/api/v2/help_center/在-我们/文章．json
             

占位符值

在JSON示例中，带下划线分隔符的大写字符表示占位符值。

             

              
｛“名称”：“APP_NAME”，“defaultLocale”：“en”，.．.｝
             

在命令和其他示例中，{}路径中指示必须替换的占位符值。例子:

             

              
得到/api/v2/用户/｛id｝．json
             

请求和响应体

每个资源的请求和响应主体都在JSON格式的表中描述。每个表都列出了资源的属性、它们的数据类型、它们是否是只读的、它们是否是必需的以及描述。

端点访问

对大多数端点的访问受到亚博Zendesk用户角色．角色在端点的Allowed For部分中指定。Zendesk用户角色的层次结构如亚博下:所有者、管理员、代理、最终用户和匿名用户。当Allowed For部分列出一个角色时，具有更高级别角色的任何用户也可以隐式地访问该端点。例如，如果Allowed For部分列出了“代理”，那么所有者和管理员也可以使用端点。