刷新accessToken
1 能力介绍
用户登录的accessToken的有效期不是无限的,为保障accessToken生命周期的延续,无须用户持续登录的情况下持续调用各账号增强能力,合作方可以通过调用刷新accessToken能力,进行accessToken的生命周期刷新。
2 接口定义
接口名称 | refreshToken.do |
接口描述 | 请求刷新用户accessToken |
承载协议 | HTTPS |
承载网络 | 公网 |
请求方式 | POST |
数据格式 | 请求参数以form表单形式提交,返回数据类型为:Json |
WEB接口URL | https://open.e.189.cn/api/oauth2/refreshToken.do |
3 请求参数
天翼账号支持以POST或GET方式提交数据,考虑到请参数长度可能受限,建议以POST方式提交,请求参数个数固定,如下表所述:
字段标识 | 说明 |
---|---|
clientId | 开发者在天翼账号开放平台申请获取的AppID |
refreshToken | 上次授权或者刷新时获取的refreshToken |
grantType | 固定为“refresh_token” |
format | 数据返回格式,默认json |
4 响应参数
字段标识 | 说明 | 数据类型 | 长度 | 可空 |
---|---|---|---|---|
result | 0:成功1:失败 | Integer | 4 | N |
accessToken | 访问第三方资源的凭证 | String | 64 | N |
refreshToken | 上次授权或者刷新时获取的refreshToken | String | 64 | Y |
expiresIn | accessToken过期时间,以返回的时间的准,单位为秒,注意过期时提醒用户重新授权 | Long | 20 | N |
msg | result不为0的时候,该字段有值 | String | 256 | Y |
正确返回结果示例:
Json示例: Content-type: text/html; charset=utf-8 { "result": 0, “msg”: ”success”, “accessToken”: ”BDLLDKki13800138000”, “refreshToken”: ”BDLLDKki13800138000”, “expiresIn”: ”3600” }
错误返回结果示例:
Json示例: Content-type: text/html; charset=utf-8 { “result”:-1, “msg”:”刷新token失败” }