获取AccessToken
accessToken是慧视云开放平台的全局唯一接口调用凭据,调用慧视云开放平台各接口时都需使用accessToken。开发者需要进行妥善保存。access_token的存储至少要保留512个字符空间。accessToken的有效期目前为2个小时,需定时刷新,每个自然日最多允许刷新1000次。
慧视云开放平台的API调用所需的accessToken使用及生成方式说明:
1、建议开发者使用中控服务器统一获取和刷新accessToken,其他业务逻辑服务器所使用的accessToken均来自于该中控服务器,不应该各自去刷新,否则容易造成刷新次数上限控制;
2、目前accessToken的有效期通过返回的expire来传达,目前是7200秒之内的值。中控服务器需要根据这个有效时间提前去刷新新accessToken。在刷新过程中,中控服务器可对外继续输出的老accessToken,新老accessToken都可用,这保证了第三方业务的平滑过渡;
3、accessToken的有效时间可能会在未来有调整,所以中控服务器不仅需要内部定时主动刷新,还需要提供被动刷新accessToken的接口,这样便于业务服务器在API调用获知accessToken已超时的情况下,可以触发accessToken的刷新流程。
接口调用说明
请求地址 : /v1/api/token/get_token
请求方式 : POST
请求头
参数名 | 参数值 | 是否必须 |
---|---|---|
Content-Type | application/json | 是 |
请求报文体
名称 | 类型 | 是否必须 | 备注 |
---|---|---|---|
appKey | 字符串 | 是 | 开发者用户唯一凭证 |
appSecret | 字符串 | 是 | 开发者用户唯一凭证密钥 |
//示例数据
{
"appKey" : "********************************",//开发者用户唯一凭证
"appSecret" : "**********************"//开发者用户唯一凭证密钥
}
响应报文
名称 | 类型 | 是否必须 | 备注 |
---|---|---|---|
code | 整数 | 是 | 状态码 |
msg | 字符串 | 是 | 状态码解释信息 |
data | 对象 | 是 | 返回内容(详情见下表) |
data内容如下:
名称 | 类型 | 是否必须 | 备注 |
---|---|---|---|
accessToken | 字符串 | 是 | 接口凭证AccessToken |
expire | 整数 | 是 | 有效时长(单位:秒;默认7200秒) |
//示例数据
{
"code":1000,//状态码
"msg":"OK",//状态码解释信息
"data":{
"accessToken":"***********.*******************.**************",//接口调用凭证access_token
"expire":7200//有效时长(秒)
}
}
错误码
状态码 | 状态描述 |
---|---|
1000 | 成功 |
1001 | 参数错误 |
1002 | 请求异常 |
1003 | appKey 或 appSecret错误 |
1012 | 该 appKey 生成的accessToken数超过最大限制 |