鉴权方法
访问凭证 access_token
- 为提升猎户星空机器人 OpenAPI(下面简称 API) 调用的安全性,猎户星空使用访问凭证(access_token)鉴权机制对调用 API 的一方进行身份鉴权,如何获取 access_token 请参考 获取 access_token;
- 在您调用 API 的同时把 access_token 传递给猎户星空,猎户星空即可识别您的身份以及权限,以此保护客户的数据安全,如何传递 access_token 请参考 使用 access_token;
- 猎户星空建议您在调用 API 之前先阅读本文档,以充分了解 access_token 鉴权机制;
获取 access_token
- 您需要调用 获取访问凭证 access_token API 来获取 access_token,请参考 获取访问凭证 access_token;
注意事项
- access_token 是一个长度在 2048 字节以内的字符串,请在缓存 access_token 的时候至少预留 2048 字节;
- 请在 access_token 的有效期内复用已经获取到的 access_token,请不要在 access_token 有效期内重复获取;
使用 access_token
- 您需要在调用 API 的同时将 access_token 传入到 HTTP 的 Authorization 请求头(Header)中,且需要在前面添加 Bearer<空格> 前缀;
Header 示例
- 假设 access_token=T.WcnhSdYj-kwVBpP27LRQrw.ori-67facfd90b2744220a5eae850e51,那么需要传递的 Header 是:
- Authorization: Bearer T.WcnhSdYj-kwVBpP27LRQrw.ori-67facfd90b2744220a5eae850e51
cURL 示例
- 以调用 获取机器人信息 API 为例;
- 假设 access_token=T.WcnhSdYj-kwVBpP27LRQrw.ori-67facfd90b2744220a5eae850e51
- 区域=中国区(域名是:https://openapi.orionstar.com)
- 那么 cURL 命令为:
curl --header 'Authorization: Bearer T.WcnhSdYj-kwVBpP27LRQrw.ori-67facfd90b2744220a5eae850e51' \ --location 'https://openapi.orionstar.com/v1/robot/robot_info?robot_sn=test_sn'