用户可以使用两种身份验证方法访问 Zendesk API。首先,他们可以使用自动生成的密码,称为 API 密钥。其次,他们可以使用 OAuth 访问密钥,这与 API 密钥不同。
在新帐户中默认禁用这两种身份验证方法。本文章说明了如何启用和禁用每种方法,以管理用户访问 Zendesk API 的方式。
有关使用 Zendesk API 的信息,请参阅以下页面:
管理对 API 的 API 密钥访问
用户可使用 API 密钥对 API 请求进行身份验证。API 密钥是自动生成的密码,可以和您的用户名相结合,用于对 API 请求进行身份验证,或用于对整合进行双重身份验证。每个 API 密钥可供帐户中任何通过验证的用户使用,并非与特定用户关联。您可以同时激活多个密钥。
API 密钥与 OAuth 访问密钥不同。请参阅 developer.zendesk.com 上的 API 密钥和访问密钥之间的区别。
要使用 API 密钥对 API 请求进行身份验证,请参阅 developer.zendesk.com 上的 API 密钥。
启用 API 密钥访问
API 密钥访问默认是禁用的。您必须在管理中心启用 API 密钥访问,用户才能使用 API 密钥。
启用 API 密钥访问的步骤
- 在管理中心,单击侧栏中的应用和整合,然后选择 API > Zendesk API。
- 在“设置”标签中,启用密钥访问。
生成 API 密钥
要生成 API 密钥,您必须是管理员,并且必须在帐户中启用 API 密钥访问。
生成 API 密钥的步骤
- 在管理中心,单击侧栏中的应用和整合,然后选择 API > Zendesk API。
- 单击活跃的 API 密钥右侧的添加 API 密钥按钮。
密钥随即生成并显示。
- (可选)输入 API 密钥描述。
- 复制密钥并将其粘贴到安全的地方。当您单击保存关闭此窗口时,完整密钥将不再显示。
- 单击保存返回 Zendesk API 页面。
如果您单击密钥将其重新打开,则会显示该密钥的删节版本。
删除 API 密钥
API 密钥就像密码:帐户中任何已通过验证的用户或任何知道其电邮地址的人都可以使用它对 API 请求进行身份验证。如果您发现某个 API 密钥已被盗用,请立即将其删除。删除密钥后该密钥将永久停用。
删除 API 密钥
- 在管理中心,单击侧栏中的应用和整合,然后选择 API > Zendesk API。
- 在列表中选择密钥,然后单击右侧的删除。
管理对 API 的 OAuth 密钥访问
您可以使用 OAuth 访问密钥对 API 请求进行身份验证。OAuth 为应用程序访问 Zendesk 数据提供了一种安全的方式,无需存储和使用 API 密钥等敏感信息。
您无法像 API 密钥那样直接在管理中心创建 OAuth 访问密钥。您必须先在管理中心创建一个 OAuth 客户端,然后在已定义的 OAuth 授权流程中使用 OAuth 客户端创建 OAuth 访问密钥。
OAuth 访问密钥与 API 密钥不同。请参阅 developer.zendesk.com 上的 API 密钥和访问密钥之间的区别。
本部分涵盖以下主题:
要使用 OAuth 访问密钥对 API 请求进行身份验证,请参阅 developer.zendesk.com 上的 OAuth 访问密钥。
创建 OAuth 客户端
OAuth 客户端使您可以创建可用于对 API 请求进行身份验证的 OAuth 访问密钥。OAuth 访问密钥与 API 密钥不同。OAuth 访问密钥为应用程序访问 Zendesk API 提供了一种安全的方式,无需存储和使用 Zendesk 用户的密码。
创建 OAuth 客户端
- 在管理中心,单击侧栏中的应用和整合,然后选择 API > Zendesk API。
- 选择 OAuth 客户端标签。
- 要创建客户端,单击添加 OAuth 客户端按钮,然后按照使用 Zendesk 注册应用程序中的说明进行操作。
- 要删除客户端,在列表中选择客户端,然后单击右侧的删除。
接下来,使用 OAuth 客户端创建一个或多个 OAuth 访问密钥。
使用 OAuth 客户端创建访问密钥
在管理中心创建 OAuth 客户端后,您可以将其与已定义的授权流程结合使用,以创建 OAuth 访问密钥。
您还可以将 OAuth 客户端与 API 结合使用,在没有授权流程的情况下创建访问密钥。您可以使用 API 密钥对这些 API 请求进行身份验证。请参阅 developer.zendesk.com 上的通过 API 创建和使用 OAuth 访问密钥。