文档 API参考

为自定义数据API调用设置Postman

Postman是一个测试api的流行应用程序。本文解释了如何设置Postman来进行自定义数据API调用。

相关信息:

需求

要自定义数据API请求，需要满足以下要求:

  • Ze亚博ndesk Suite计划中的Zendesk帐户。你也可以申请一个赞助的测试帐户用于测试目的。
  • 邮差应用程序-下载并安装应用程序注册一个免费帐户上邮递员的网站。
  • 用于发出API请求的身份验证方法——您必须首先是验证用户发出Zendes亚博k API请求。您可以使用带有您的电子邮件地址和密码的基本身份验证，或者使用您的电子邮件地址和API令牌对API进行授权。在管理中心界面应用程序和集成>api>亚博Zendesk api。有关更多信息，请参见安全与认证在Zendes亚博k支持API参考中。

导入邮差收藏

Postman允许创建包含一系列预构建API请求的集合。亚博Zendesk为自定义对象API、配置文件API和事件API提供了Postman集合。

导入Postman集合

  1. 下载邮差系列的自定义对象API，概要文件的API,或事件API。
  2. 打开您的Postman应用程序。
  3. 点击进口打开导入窗口。
  4. 在窗口中拖放Postman集合文件以导入集合。

设置环境变量

在使用集合在Postman中进行API调用之前，需要为集合配置以下变量。

授权

在Postman中，您可以为集合配置授权方法。不要忘记首先在Zendesk Support管理界面中启用和配置您的授权方法亚博https:// {your_subdomain}亚博 .zendesk.com/agent/admin/api/settings。

为集合设置授权

  1. 右键单击侧边栏中的集合，然后选择编辑。

  2. 选择授权选项卡。

  3. 下类型下拉选项，选择基本认证并输入您在Zendesk支持管理界面中启用的用户名和密码。亚博如果您正在使用API令牌，请在您的用户名后面附加“/token”，并粘贴在Zendesk Support管理界面中生成的API令牌作为密码。亚博

  4. 如果使用OAuth访问令牌，在类型下拉选项，选择不记名的令牌，并粘贴令牌。有关OAuth身份验证的信息，请参见对应用程序使用OAuth身份验证。

  5. 点击更新。

亚博Zendesk子域名

在集合中，URL路径中的双花括号定义了一个变量。您可以设置集合的值，以便它将用于所有API请求。

{{baseUrl}} / api / v2 / user_profiles /: profile_id

您的Zendesk子域的URL参数是亚博{{baseUrl}}对于概要文件和事件，或{{子域名}}用于自定义对象。

设置Zendesk子域亚博

  1. 右键单击侧边栏中的集合，选择编辑，然后选择变量选项卡。
  2. 对于变量名，为自定义对象集合输入“子域”，或为概要文件集合或事件集合输入“baseURL”。
  3. 下初始值，输入您的Zendesk帐亚博户子域，然后单击更新。

请求格式

Content-Type实体标头表示资源媒体类型。这取决于HTTP方法:

  • POST请求需要一个“Content-Type: application/json”报头
  • PATCH请求需要自定义对象的“Content-Type: application/merge-patch+json”头，配置文件和事件的“Content-Type: application/json”头
  • GET请求应该返回"Content-Type: application/json"

所有请求的Accept头被设置为“application/json”头。

在Postman中，您可以为集合中的HTTP方法设置报头。

为集合中的HTTP方法设置标头

  1. 在侧边栏中，从集合中选择一个API请求。
  2. 选择头选项卡。
  3. 在关键字段，输入“Content-Type”，然后在价值字段，从下拉列表中选择本节前面提到的HTTP方法的适用值。
  4. 在关键字段，输入“Accept”，然后在价值字段，选择“application/json”。
  5. 点击保存。对于集合中使用相同HTTP方法的请求，保留请求头。

设置请求参数

API请求还可以包含请求参数。元素前的冒号将在元素中创建一个路径变量参数个数选项卡。

在参数个数选项卡，添加键和值，然后单击保存保存端点。

还可以使用冒号和元素格式向路径添加查询参数。它们被添加到参数个数选项卡和值可以更改和保存。这对于概要API中的标识符查询特别有用。

有关标识符查询的详细信息，请参见对配置文件使用标识符查询。