跳到主要内容

刷新会话(必接)

接口描述

用于刷新会话的Token。刷新会话成功后accessToken与refreshToken信息不变,会话时间延长30天,需要确保30天内能刷新成功,延长会话有效期

请求地址

环境服务地址(HTTP/HTTPS)
V2正式环境(推荐)https://gw.superboss.cc/router

2022年4月1日以后申请的APP Key,统一使用V2正式环境的请求地址:https://gw.superboss.cc/router 开放平台对accessToken的过期时间默认设置为30天,所以开发者在会话过期前, 请尽快对接【刷新会话(必接)】接口(接口路径:API文档-基础-刷新会话(必接)), 否则调用API的请求将被平台拒绝。如果会话过期, 请及时联系实施或客服去问题群让业务机器人开通, 开放平台刷新授权格式:公司名称-开放平台刷新授权-appKey;方可继续使用。 刷新会话成功后accessToken与refreshToken信息不变,会话时间延长30天。

公共参数

调用任何一个API都必须传入的参数,目前支持的公共参数有:

参数名称参数类型是否必须参数描述
methodstringAPI接口名称
appKeystring分配给应用的AppKey
timestampstring时间戳,时区为GMT+8,例如:2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟
formatstring响应格式。默认为json格式,可选值:json
versionstringAPI协议版本 可选值:1.0
sign_methodstring签名的摘要算法(默认 hmac),可选值为:hmac,md5,hmac-sha256。
signstring签名
sessionstring授权会话信息 (即access_token,由系统分配)

请求头

参数名
类型
描述
必填
Content-Type
string
multipart/form-data
必填

API接口地址

参数名
类型
描述
必填
method
string
open.token.refresh
必填

请求参数

参数名
类型
描述
必填
默认值
refreshToken
string
用于刷新会话的token
必填

请求示例

示例一:

{
"refreshToken":"string"
}

响应参数

参数名
类型
描述
必填
session
object
session
必填
expiresIn
long
到期时间
必填
companyId
long
关联的企业ID
必填
accessToken
string
会话Token
必填
userId
long
关联的用户ID
必填
refreshToken
string
用来刷新会话的Token
必填

响应示例

{
"session": {
"expiresIn": long,
"companyId": "long",
"accessToken": "string",
"userId": long,
"refreshToken": "string"
}
}

异常示例

{
"code": "25",
"msg": "服务方法(item.single.get:1.0)的签名无效",
"success": false,
"trace_id": "3553483395423660"
}

错误码解释