获取授权令牌
简要描述
业务接口请求时必须携带的授权令牌,使用 token 机制,在所有请求header中传入token数据。
注意事项
请求地址
/v4/api/auth/authorize请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| clientId | 是 | string | 点击查看客户编号 |
| clientSecret | 是 | string | 点击查看客户密钥 |
入参示例
json
{
"clientId":"账户中心:API安全获取",
"clientSecret":"账户中心:API安全获取"
}返回参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| expire | string | 过期时间 |
| token | string | 访问令牌 |
请在后续所有接口调用Headers中添加获取令牌返回的token值 , expire 为令牌过期时间,到期后需要重新获取令牌。
数据格式
返回格式:JSON
返回数据格式
json
{
"code": 200,
"msg": "业务处理成功",
"data": {
},
"total": 0,
"resultId": "12117e07"
}| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 200:表示业务受理成功,其他均为失败; 514:请求来源IP,不在绑定IP白名单中; 403:无接口访问权限; 410:使用的token过期,需重新获取; |
| msg | string | 接口响应结果描述 |
| data | json | 业务接口返回的数据 |
| total | long | 分页获取数据时,total为数据总条数 |
| resultId | string | 请求链路编号,用于联合调试排查问题 |
通用状态码
| 状态码 | 描述 |
|---|---|
| 200 | 业务处理成功 |
| 500 | 业务处理失败 |
| 410 | 用户信息已过期,请重新登陆! |
| 501 | 业务系统发生异常 |
| 505 | 业务系统发生异常 |
