auth.checkSessionKey

接口说明

校验用户登录态 session_key 是否有效。开发者可以通过该接口检测用户登录态是否过期。

接口地址

国内：

GET https://cloud-miniapp.tapapis.cn/auth/v1/checksession

国际：

GET https://cloud-miniapp.tapapis.com/auth/v1/checksession

请求参数

属性	类型	默认值	必填	说明
openid	string		是	用户唯一标识
access_token	string		是	接口调用凭证
signature	string		是	用户签名，参考签名验证
sig_method	string	hmac_sha256	是	签名方法，目前仅支持 hmac_sha256

返回结果

正常返回

HTTP 状态码为 200，无返回数据。

错误返回

{
  "errcode": 87009,
  "errmsg": "invalid signature"
}

属性	类型	说明
errcode	number	错误码
errmsg	string	错误信息

错误码

错误码	说明
1040001	无效的 Access Token
1087009	无效的 signature

示例代码

请求示例

GET https://cloud-miniapp.tapapis.cn/auth/v1/checksession?openid=OPENID&access_token=ACCESS_TOKEN&signature=SIGNATURE&sig_method=hmac_sha256

错误返回示例

{
  "errcode": 87009,
  "errmsg": "invalid signature"
}