文档 API参考

介绍

这是Zendesk帮助中心API的参考文档。亚博

任何通用机制和约定(如分页和身份验证)都按照亚博Zendesk API介绍并被认为隐含在这篇文章中。

响应总是根据代表其发出API请求的用户的权限进行过滤。例如，当用户请求某个部分中的文章列表时，API只返回用户可以在Help Center中查看的文章。

该API仅适用于帮助中心项。例如，可以对文章和请求进行评论，但是Help Center API只提供对文章评论的访问。这意味着返回“用户发表的所有评论”的端点实际上返回的是“用户对Help Center文章发表的所有评论”。

如果您有多个品牌，则必须在API请求中使用特定于品牌的子域。例如，如果您有一个名为brand1的品牌，那么关于该品牌帮助中心内容的信息请求可能是这样的https://brand1.亚博zendesk.com/api/v2/help_center/..。．

邮差跑进来

如果你使用Postman，你可以将Help Center API端点作为一个集合导入到你的Postman应用中，然后尝试不同的请求来了解API是如何工作的。点击以下按钮开始:

邮差跑进来

如果你不使用邮差，你可以注册一个免费帐户邮递员的网站下载应用程序。

数据类型

以下是Zendesk帮助中心API的具体内容:亚博

  • 亚博Zendesk建议在帮助中心使用字符串类型作为id。
  • 区域设置作为字符串返回并传递。例如:“en - us”。

有关api中使用的数据类型的详细信息，请参见数据类型在通用API介绍中。

分页

Help Center API支持通过结果进行分页的两种方法:游标分页和偏移分页。

基于游标的分页是首选的分页方法，可用于大多数端点。控件来激活游标分页页面(大小)参数(如。?(大小)= 30页)到API端点。有关更多信息，请参见使用基于游标的分页在通用API介绍中。

偏移分页可用于向后兼容，其工作方式如使用偏移分页在通用API介绍中。亚博Zendesk将偏移分页的可用页数限制为100，将来可能会进一步限制。使用偏移分页时，大多数帮助中心列表请求默认情况下每页返回30条记录。您可以在每个请求的基础上通过包含per_page参数在请求的查询字符串中。例子:per_page = 100．但是，对于大多数请求，每页不能超过100条记录。

速度限制

帮助中心API遵循支持API的每分钟请求数限制。看到速度限制在通用API介绍中。一个API中的请求不计入另一个API的速率限制。