Table of Contents

获取访问凭证 access_token

概述

授权方式

接口维度授权 默认授权 此 API 为默认授权，您无需为您的授权账号额外申请接口维度授权就可以调用。请参考 授权方式。

注意事项

  • 此 API 有 ip 访问限制；
  • 您在申请授权账号的时候需要告知调用此 API 的服务端（调用端）外网出口 ip 地址，猎户星空需要把此 ip 地址添加到白名单中之后您才能成功调此 API；
  • 请参考 调用流程 和 授权方式；
  • 注意：secret 请务必仅在服务端保存和使用，请不要在 web 前端或客户端保存和使用，防止 secret 泄露；

请求

请求域名

区域 域名
中国区 https://openapi.orionstar.com
欧洲区 https://global-openapi.orionstar.com
美国区 https://us-openapi.orionstar.com
日本区 https://jp-openapi.orionstar.com

请求协议

HTTP URL 路径 /v1/auth/get_token
HTTP Method GET

请求 URL 参数

参数 类型 必填 参数说明
appid string 是 猎户星空颁发的 appid
secret string 是 猎户星空颁发的 secret
grant_type string 是 固定常量字符串 client_credential

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/v1/auth/get_token?appid=test_appid&secret=test_secret&grant_type=client_credential'

响应

公共响应体

参数 类型 参数说明
code int 错误代码。0 是成功，非 0 是失败，请参考 错误代码。
msg string 错误描述，当失败的时候会给出具体的错误描述。
req_id string 日志跟踪 id，当遇到问题需要猎户星空协助查问题时候，请提供此跟踪 id 值。
data object 业务数据 data 对象，详见下述 响应体 data 对象。

响应体 data 对象

参数 类型 参数说明
access_token string access_token
expire_in int access_token 的有效期，一般是 2 个小时有效期，具体有效期以返回为准。单位是秒。

响应体示例

{
    "code": 0,
    "msg": "",
    "data": {
        "access_token": "test_access_token",
        "expire_in": 7200
    }
}