获取 SIGN ticket

最近更新时间:2024-07-29 17:21:41

我的收藏

注意事项

前置条件:请合作方确保 Access Token 已经正常获取,获取方式请参见 获取 Access Token
用途:SIGN ticket 是合作方后台服务端业务请求生成签名鉴权参数之一,用于后台查询验证结果、调用其他业务服务等。
API ticket 的 SIGN 类型,必须缓存在磁盘,并定时刷新,刷新的机制如下:
因为 API ticket 依赖于 Access Token 为了简单方便,建议将 API ticket 与 Access Token 绑定,每20分钟定时刷新,且不能并发刷新。
获取新的之后请立即使用最新的,旧的有一分钟的并存期。
如果未按照上述做定时刷新,可能导致鉴权不通过,影响人脸服务正常调用。

请求

请求 URL:https://kyc1.qcloud.com/api/oauth2/api_ticket
请求方法:GET
请求参数:
参数
说明
类型
长度(字节)
是否必填
appId
业务流程唯一标识,即 wbappid,可参考 获取 WBappid 指引在人脸核身控制台内申请
String
8
access_token
请根据 获取 Access Token 指引进行获取
String
90
type
ticket 类型,默认值:SIGN(必须大写)
String
20
version
版本号,默认值:1.0.0
String
20
请求示例:
https://kyc1.qcloud.com/api/oauth2/api_ticket?appId=xxx&access_token=xxx&type=SIGN&version=1.0.0

响应

响应参数:
参数
类型
说明
code
String
0:成功
非0:失败
详情请参见 SaaS 服务错误码
msg
String
请求结果描述
transactionTime
String
调用接口的时间
tickets
list
ticket 返回数组
value
String
ticket 的值
expire_time
String
ticket 失效的绝对时间
expire_in
int
ticket 的最大生存时间
响应示例:
{
"code": "0",
"msg": "请求成功",
"transactionTime": "20151022044027",
"tickets": [
{
"value": "ticket_string",
"expire_in": "3600",
"expire_time": "20151022044027"
}
]
}
注意
code 不为0则表示获取失败,可以根据 code 和 msg 字段进行定位和调试。code 详情请参见 SaaS 服务错误码
expire_in 为 SIGN ticket 的最大生存时间,单位:秒,合作伙伴在判定有效期时以此为准
expire_time 为 SIGN ticket 失效的绝对时间,由于各服务器时间差异,不能以此作为有效期的判定依据,只作为展示使用。
access_token 失效时,该 access_token 生成的 ticket 都失效。
tickets 只有一个。