密钥鉴权¶
调用地址:登录域名(不清楚请联系我们)
POST /prod-api/auth/authentication
通过控制台密钥换取调用其他 API 的 token。
控制台「创建密钥」弹窗中的 accessKeyId 对应请求体 appKey,accessKeySecret 对应请求体 secret。accessKeySecret 只在创建时展示一次,请妥善保存。
data.expires_in 为 120,表示 token 有效期 120 分钟。调用需要鉴权的 API 且 token 仍有效时,有效期会重新计为 120 分钟。access_token 在有效期内保持不变。连续 120 分钟没有任何请求后 token 失效,需重新调用本接口获取。
调用示例¶
请将 {登录域名}、appKey、secret 替换为实际值。appKey 填控制台 AccessKeyId,secret 填控制台 AccessKeySecret。
1. 获取 Token
curl -X POST 'https://{登录域名}/prod-api/auth/authentication' \
-H 'Content-Type: application/json' \
-d '{
"appKey": "{AccessKeyId}",
"secret": "{AccessKeySecret}"
}'
成功时返回示例:
{
"code": 200,
"msg": null,
"data": {
"access_token": "eyJhbGciOiJIUzUxMiJ9.xxxxxx",
"expires_in": 120,
"old_token": "xxxxxx"
}
}
后续请求使用 data.access_token。old_token 不放入 Authorization。
2. 使用 Token 调用其他 API
curl -X GET 'https://{登录域名}/prod-api/xxx/xxx' \
-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.xxxxxx'
请求参数¶
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| appKey | body | string | 是 | 控制台 AccessKeyId |
| secret | body | string | 是 | 控制台 AccessKeySecret |
返回数据结构¶
成功时 code 为 200。
| 名称 | 类型 | 说明 |
|---|---|---|
| code | integer | 状态码。成功为 200 |
| msg | string | 提示信息。成功时为 null |
| data.access_token | string | 调用其他 API 时放入请求头 Authorization,格式为 Bearer {access_token} |
| data.expires_in | integer | 有效时长,单位分钟。固定为 120 |
| data.old_token | string | 不用于 Authorization |
错误码¶
失败时 HTTP 状态码一般为 200,正文 code 为 500,msg 为下表原文。
| 业务提示 | 描述 |
|---|---|
| appKey/secret必须填写 | appKey 或 secret 为空 |
| The appKey or secret is incorrect | 密钥不匹配 |
| The appKey has been disabled | 密钥已停用 |
| The account has been logged out or does not exist | 账号不存在或已注销 |
| The account has been frozen | 账号已冻结 |
| 登录用户:{username} 不存在 | 登录用户不存在 |
| 对不起,您的账号:{username} 已被删除 | 账号已删除 |
| 对不起,您的账号:{username} 已停用 | 账号已停用 |