取消
最近搜索
清空历史

检测密钥令牌

1. 接口描述

https://auth.kdlapi.com/api/check_secret_token 英文代号:check secret token

检测密钥令牌的有效性。

  • 本接口只支持HTTP POST请求
  • 接口最快调用频率: 1秒10次

2. 参数说明

参数 是否必填 参数说明 取值说明
secret_id 订单或账户SecretId 查看API密钥信息
secret_token 与SecretId对应的密钥令牌 通过获得密钥令牌接口得到的令牌

3. 调用示例

假定您正常使用的SecretId和SecretToken如下:

  • SecretId:o1fjh1re9o28876h7c08
  • SecretToken:oxf0n0g59h7wcdyvz2uo68ph2s

调用示例

POST https://dev.kdlapi.com/api/check_secret_token HTTP/1.1
Content-Type: application/x-www-form-urlencoded

secret_id=o1fjh1re9o28876h7c08&secret_token=oxf0n0g59h7wcdyvz2uo68ph2s

使用说明

点击查看关于API授权与验证的介绍

4. 返回结果

接口返回json格式,样例:

令牌有效期5分钟以上则返回:

{
  "code": 0,
  "msg": "ok",
  "data": {
    "expire": 1650
  }
}

令牌距离到期不足5分钟则返回:

{
  "code": -5,
  "msg": "expiring",
  "data": {
    "expire": 240
  }
}

令牌已过期则返回:

{
  "code": -107,
  "msg": "expired",
  "data": {
    "expire": 0
  }
}

字段说明如下:

参数 说明
code 返回码。取值:0代表令牌有效 非0代表需要重新获得令牌
msg 错误信息
data.expire 密钥令牌距离过期的剩余时长(单位:秒)

5. 错误码一览

错误码 说明
-1 缺少参数
-2 secret_id / secret_token参数错误
-5 令牌距离到期不足5分钟
-107 令牌已过期

6. SDK

快代理提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

SDK下载

联系我们