亚博Zendesk提供了3种验证API请求的方法:

  • OAuth访问令牌
  • API的令牌
  • 使用用户名和密码进行基本身份验证

当需要用户授予应用程序对其帐户的访问权限时,通常会选择OAuth令牌。这涉及到建立一个OAuth授权流程

您还可以对不需要用户授权的其他类型的请求使用OAuth令牌。例如,您可以在内部员工或公众使用的应用程序中使用它们。使用OAuth令牌进行身份验证不会将请求绑定到特定的用户名和密码,而且与普通API令牌相比,它提供了更多的控制和安全性。

下面的例子是一个使用OAuth令牌进行身份验证的请求:

             
旋度https//针孔亚博com/api/v2/用户json \-H“授权:Bearer 52d7ef4ee01e2c2c75bff572f957cd4f12d6225eee07ea2f01d01a”

警告: OAuth访问令牌类似于密码。确保安全。如果您在任何时候怀疑令牌已被泄露,请立即撤销它。看到撤销令牌

使用Zendesk API创建令牌亚博

本节描述了使用Zendesk API创建OAuth访问令牌的步骤:亚博

  1. 创建OAuth客户端
  2. 获取客户端id
  3. 创建访问令牌
  4. 在请求中使用访问令牌

您可以使用基本身份验证或API令牌来发出Zendesk API请求。亚博不要将API令牌与OAuth访问令牌混淆。您可以从Support管理界面获得API令牌。看到使用Zendes亚博k API令牌在支持API文档中。

如果您的组织使用单点登录(SSO)和Zendesk密亚博码已从Zendesk帐户中删除,您必须使用API令牌来发出请求。

创建OAuth客户端

  1. 管理中心,点击应用程序和集成图标(),然后选择api>亚博Zendesk API>OAuth客户
  2. 填写表格。看到在Zendesk上注册应用程序亚博获取详细信息。

获取客户端id

使用客户列表端点获取新客户机的id。

请求

基本身份验证

             
旋度https://子域名}.亚博zendesk.com/api/v2/oauth/clients.json- v - uemail_address}密码}

API的令牌

             
旋度https://子域名}.亚博zendesk.com/api/v2/oauth/clients.json- v - uemail_address}/令牌:api_token}

响应

             
“客户”“名称”“为我的应用程序创建客户端”“id”50328“user_id”293241756}]}

创建访问令牌

中使用客户端id创建令牌端点获取访问令牌。

该端点只能由支持管理员使用。

请注意:如果管理员的角色稍后更改为代理或最终用户,则令牌的访问权限也将更改为新角色的访问权限。例如,它将不再使用仅允许管理员使用的端点。

请求

基本身份验证

             
旋度https://子域名}.亚博zendesk.com/api/v2/oauth/tokens.json- d”{“令牌”:{“client_id”:“50328”,“范围”:[“读”、“写”]}}”- h“application / json内容类型:-X POST -v -uemail_address}密码}

API的令牌

             
旋度https://子域名}.亚博zendesk.com/api/v2/oauth/tokens.json- d”{“令牌”:{“client_id”:“50328”,“范围”:[“读”、“写”]}}”- h“application / json内容类型:-X POST -v -uemail_address}/令牌:api_token}

中了解有关作用域的更多信息设置范围在Zendes亚博k支持帮助中心。

响应

             
“令牌”“full_token”“52 d7ef4ee01e2c2c75bff572f957cd4f12d6225eee07ea2f01d01a”“范围”“读”“写”]}}

full_token属性指定访问令牌。将价值保存在安全的地方。

在请求中使用访问令牌

在请求的授权标头中使用访问令牌。例子:

             
旋度https://子域名}.亚博zendesk.com/api/v2/users.json- h“授权:Bearer 52d7ef4ee01e2c2c75bff572f957cd4f12d6225eee07ea2f01d01a”

在卷曲中,- hFlag表示报头字段。