- 接口说明
Access-Token是全局唯一接口调用凭据,开发者需要进行妥善保存。Access-Token的存储至少要保留128个字符空间。Access-Token的有效期为2个小时,需定时刷新,重复获取将导致上次获取的Access-Token失效。
API调用所需的Access-Token的使用及生成方式说明:
1、建议开发者使用中控服务器统一获取和刷新Access-Token,其他业务逻辑服务器所使用的Access-Token均来自于该中控服务器,不应该各自去刷新,否则容易造成冲突,导致Access-Token覆盖而影响业务;
2、目前Access-Token的有效期通过返回的expire_in来传达,目前是7200秒之内的值。中控服务器需要根据这个有效时间提前去刷新新Access-Token。在刷新过程中,中控服务器可对外继续输出的老Access-Token,此时后台会保证在5分钟内,新老Access-Token都可用,这保证了第三方业务的平滑过渡;
3、Access-Token的有效时间可能会在未来有调整,所以中控服务器不仅需要内部定时主动刷新,还需要提供被动刷新Access-Token的接口,这样便于业务服务器在API调用获知Access-Token已超时的情况下,可以触发Access-Token的刷新流程。
- 请求地址
请求方式:GET
请求地址:http://api.hisiphp.com/oauth/token
- 请求参数
| 参数 | 是否必须 | 说明 |
| app_id | 是 | |
| grant_type | 是 | 固定值:access_token |
| timestamp | 是 | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
| signature | 是 | 请求参数签名,点此查看签名算法 |
- 成功返回示例
{
"code": 200,
"message": "success",
"data": {
"access_token": "28C52ACF66BA91B0FD8E157F15D6747F",
"expires_in": "7200"
}
}| 参数 | 说明 |
| code | 状态码(200 正常) |
| message | 结果说明,正常返回suceess |
| data | 数据结果 |
| └ access_token | 获取到接口调用的凭证 |
| └ expires_in | 凭证有效时间,单位:秒 |
- 失败返回示例
{
"code": 401,
"message": "Request timed out!"
}| 参数 | 说明 |
| code | 状态码 |
| message | 返回失败原因 |