安全性和身份验证
你一定是个验证用户进行API请求。您可以使用电子邮件地址和密码、电子邮件地址和API令牌或OAuth访问令牌的基本身份验证对API进行授权。
客户端歌珥请求被支持,如果请求是通过OAuth访问令牌.如果请求使用基本身份验证或Zendesk API令牌,则不支持该请求。亚博有关更多信息和教程,请参见创建跨源的浏览器端API请求.
本节涵盖的主题:
基本身份验证
您可以使用电子邮件地址和密码访问API。凭据必须在HTTP请求中的Authorization报头中发送。在请求正文或URL中发送的凭据将被忽略。
要使用基本身份验证,必须在管理中心接口应用程序和集成>api>亚博Zendesk API.
使用基本身份验证验证请求
把你的电子邮件地址和密码用冒号组合起来。例子:
(电子邮件保护): pa w0rd美元美元
.对结果字符串进行base64编码。例子:
amRvZUBleGFtcGxlLmNvbTpwYSQkdzByZA = =
.在HTTP授权标头中包含base64编码的字符串,如下所示:
授权:基本{base64-编码-字符串}
例子:
授权:基本amRvZUBleGFtcGxlLmNvbTpwYSQkdzByZA= =
请注意:大多数HTTP请求库都有简化基本身份验证的方法。
要了解更多信息,请参见API请求的身份验证在支持帮助中心。
如果你使用curl来测试不同的端点,你可以使用下面的格式:
旋度https://obscura.亚博zendesk.com/api/v2/users.json\
- u(电子邮件保护):爸爸\$\w0rd美元
如果代理或管理员在其用户配置文件中启用了2因素身份验证,则他们将不能使用基本身份验证。替代方案包括使用API令牌或实现OAuth流。了解更多.
API的令牌
API令牌不同于OAuth令牌,OAuth令牌将在下一节中详细介绍。API令牌是支持管理界面中自动生成的密码。
警告:作为密码,API令牌可以用来模拟帐户中的任何人,包括管理员。确保它们的安全。删除任何未使用的令牌。如果您怀疑某个令牌已被破坏,请立即删除它,并在必要时创建另一个令牌。另一种选择是使用OAuth令牌,这将在下一节中描述。
API令牌在Admin Center界面中管理应用程序和集成>api>亚博Zendesk API.该页面允许您查看、添加或删除令牌。可以同时激活多个令牌。删除令牌会永久停用它。
基本身份验证用于API令牌。如在基本身份验证以上,凭证必须在授权报头中与请求一起发送。
使用以下格式的凭证:
{email_address} /令牌:{api_token}
例子:
(电子邮件保护).com/令牌:6wiIBWbGkBMo1mRDMuVwkw1EPsNkeUj95PIz2akv
在对结果字符串进行base64-encoding之后,将其添加到Authorization头,如下所示:
授权:基本amRvZUBleGFtcGxlLmNvbS90b2tlbjo2d2lJQldiR2tCTW8xbVJETXVWd2t3MUVQc05rZVVqOTVQSXoyYWt2
如果你使用curl来测试不同的端点,你可以使用下面的格式:
旋度https://obscura.亚博zendesk.com/api/v2/users.json\
- u(电子邮件保护)/令牌:6 wiibwbgkbmo1mrdmuvwkw1epsnkeuj95piz2akv
如果通过HTTP进行身份验证,则对斜杠字符进行url编码{email_address} /令牌
作为% 2 f
.
OAuth访问令牌
Zend亚博esk API支持OAuth授权流。了解更多.
OAuth访问令牌还允许客户端API请求。看到创建跨源的浏览器端API请求在Zendes亚博k API指南中。
在请求中,在授权头中指定访问令牌,如下所示:
授权:持有者{access_token}
例子:
授权:持票人gErypPlm4dOVgGRvA1ZzMH5MQ3nLo8bo
如果你使用curl来测试不同的端点,你可以使用下面的格式:
旋度https://obscura.亚博zendesk.com/api/v2/users.json\
- h“授权:持有人gErypPlm4dOVgGRvA1ZzMH5MQ3nLo8bo”
SSL需求
Zend亚博esk v2 API是一个只支持ssl的API,无论您的帐户如何配置。
所有到Zendesk API的连接必须支持TL亚博S 1.2协议。对TLS 1.0和1.1的支持已于2018年6月移除。
到API的连接还必须支持TLS的SNI扩展。
如果您通过客户端库连接到Zendes亚博k,请确保它同时支持TLS 1.2和SNI。