简介

Zend亚博esk自定义数据api允许您连接和了解所有客户数据，无论其位于何处。它由自定义对象API、配置文件API和事件API组成。

计划可用性

自定义对象API、配置文件API和事件API可在Zendesk Suite团队计划及以上版本中使用。亚博

文档

这是用于自定义数据的API参考文档。它涵盖以下api:

• 自定义对象API
• 概要文件的API
• 事件API

除了API文档之外，在开发帮助中心还可以获得以下资源。亚博电脑端

开始

• 什么是自定义数据api ?
• 从自定义对象开始
• 从简介开始
• 从事件开始

指南和教程

• 自定义对象API开发人员指南
• Profiles API开发人员指南
• 事件API开发人员指南

社区

• 亚博Zendesk api

例子

有关api中使用的curl示例的信息，请参见例子．

安全性和身份验证

Profiles和Events api支持标准OAuth作用域。概要文件和事件资源是亚博电脑端用户资源。例如，用户:读作用域授予对所有概要文件和事件资源的读访问权。亚博电脑端有关更多信息，请参见对应用程序使用OAuth身份验证而且安全性和身份验证．

速度限制

API在标准创建端点上强制执行速率限制。有关Zendesk Suite计划限制的信息，请参见亚博亚博Zendesk Suite计划限制．速率限制包括来自Zendesk应用程序框架的请求。亚博

要列出帐户的限制，请参见自定义对象限制．

有关每分钟允许的请求数的一般信息，请参见速度限制．

配置文件

下表显示了概要文件硬限制。可用性和限制可能因Zendesk Suite计划类型而异。亚博

类别	限制
配置文件	30000000年
资料来源	50
概要文件类型	2500
每个配置文件的标识符	20.
配置文件源字符长度	40
概要类型字符长度	40
标识符源字符长度	60
标识符类型字符长度	60

事件

下表显示了事件硬限制。可用性和限制可能因Zendesk Suite计划类型而异。亚博

类别	限制
事件源	50
事件类型	2500
事件源字符长度	40
事件类型字符长度	40

请求格式

• 所有POST请求都需要一个“Content-Type: application/json”报头

• 所有PATCH请求都需要一个“Content-Type: application/merge-patch+json”报头

• 所有GET请求都应该返回“Content-Type: application/json”

有关JSON请求格式的信息，请参见请求格式．

响应格式

API使用中描述的标准响应代码响应格式．

此外，任何端点如果接受不存在的URL参数或任何不正确的URL，都可能返回“404 - Not Found”。“500 -内部服务器错误”可以在任何时间从任何端点返回，以防服务失败。中所记录的任何端点也可以返回“429 -太多请求”速度限制．

幂等性

Events API允许您指定一个等幂键，该键允许用户重试API请求，而不会有创建重复记录的风险。例如，如果在应用程序中单击一个按钮会触发一个请求POST / api / v2 / user_profiles /事件端点时，可以使用幂等键防止后续单击创建重复的事件记录。

要在请求中指定幂等键，请在请求中提供标题“x - idempotent - key: key_value”。键可以是长度小于或等于48的任何字符串。

下面的事件API路径接受等幂键:

• POST / api / v2 / user_profiles /事件

当接收到带有等幂键的请求时，如果之前没有看到该键，则请求将正常进行。如果之前使用过该密钥，服务器将以“409”状态码响应。

密钥在4小时后过期，因此如果在原始请求的4小时后发送带有重复密钥的请求，则该请求将被允许继续执行。

Custom Objects API和Profiles API不支持等幂键。

分页

分页工作如中所述分页，除了以下不同之处:

• 的sort_order参数被称为订单=自定义对象API
• 的per_page自定义对象API中的参数最多可以接收1000条记录，而不是在Zendesk v2 API中的大多数端点上每页接收100条记录亚博

响应体也不同。的响应对象不包含接下来\ _page或前\ _page属性。相反，它有一个链接属性的顶部下一个而且以前的孩子的属性。

概要文件和事件api

Profiles和Events api使用基于游标的分页。您将收到下一页的分页令牌。您可以指定诸如?项目指定窗口大小。

数据类型

有关api返回的数据类型的信息，请参见数据类型．

遗留计划限制

按传统Sunshine计划类型划分的费率限制如下表所示。

阳光Lite	阳光团队	阳光的职业	阳光企业
每分钟250个请求	每分钟500个请求	每分钟700个请求	每分钟1000个请求

自定义对象存储限制

下表按传统Sunshine计划类型显示了存储限制。有关更多信息，请参见关于Zendesk 亚博Sunshine计划类型．

	阳光Lite	阳光团队	阳光的职业	阳光企业
对象类型*	50	50	50	50
对象的大小	32 KB	32 KB	32 KB	32 KB
对象记录	100000年	250000年	1000000年	25000000年
关系类型*	50	50	50	50
关系的记录	100000年	250000年	1000000年	25000000年

*类型限制是软限制。要了解有关提高此限制的详细信息，请联系您的销售代表。有关Zendesk Suite计划上的自定义对象存储限制的信息，请参见亚博亚博Zendesk Suite计划限制．

法律声明

该产品包括由MaxMind创建的GeoLite2数据，可从https://www.maxmind.com．

有关使用api的法律合规性的信息，请参见法律通知．