1. 获取access_token
获取access_token是调用API接口的第一步,相当于创建了一个登录凭证,其它的API接口,
都需要依赖于access_token来鉴权调用者身份。
凭证默认有效期为7200秒,请在凭证失效前重新得到凭证或者使用延期接口得到新凭证。
请求方式: POST(HTTP/HTTPS)
请求地址: /api/ou/getToken
提示:
此地址没有域名或者IP,请根据服务器地址或者IP组合具体地址。
其它接口也需要处理服务器地址,以后不再说明。
例如:https://api.abc.com:92/api/ou/getToken
请求包示例:
{
"name":"apiUser",
"password":"262b706490a1c5d27228e0823842608a"
}
参数说明:
返回结果示例::
{
"errcode": 0,
"errmsg": "",
"accessToken": "01b924ba3a89016ed9012c2eafb338d5da5bf950ade16b9c",
"expireIn": 7200
}
返回参数说明::
| 参数 | 类型 | 说明 |
| errcode |
int32 |
出错返回码,为0表示成功,非0表示调用失败 |
| errmsg |
string |
返回码提示语 |
| accessToken |
string |
获取到的凭证,其他接口使用此凭证调用接口 |
| expireIn |
int32 |
凭证的有效时间(秒) |
2. access_token延期
用旧的access_token获取新的凭证有效期,时间从提交数据时间开始计算。
请求方式: GET(HTTP/HTTPS)
请求地址: /api/ou/tokenDefer?token=ACCESS_TOKEN
提示:
此处标注大写的单词ACCESS_TOKEN,为需要替换的变量,根据实际获取值并更新。
其它接口也采用相同的标注,不再说明。
参数说明:
| 参数 | 类型 | 必须 | 说明 |
| name |
string |
是 |
接口用户登录账号 |
| token |
string |
是 |
上一个用户登录接口后获取到的凭证 |
返回结果示例::
{
"accessToken":"e7e5d903a04b0f05c04a04a37dc6280bd1a59552dc6fc02a",
"expireIn": 7200,
"errcode": 0,
"errmsg": ""
}
返回参数说明::
| 参数 | 类型 | 说明 |
| errcode |
int32 |
出错返回码,为0表示成功,非0表示调用失败 |
| errmsg |
string |
返回码提示语 |
| accessToken |
string |
获取到的凭证,其他接口使用此凭证调用接口 |
| expireIn |
int32 |
凭证的有效时间(秒) |