檢測密鑰令牌
1. 接口描述
https://auth.kdlapi.com/api/check_secret_token 英文代號:check secret token
檢測密鑰令牌的有效性。
- 本接口只支持HTTP POST請求
- 接口最快調(diào)用頻率: 1秒10次
2. 參數(shù)說明
| 參數(shù) | 是否必填 | 參數(shù)說明 | 取值說明 |
|---|---|---|---|
| secret_id | 是 | 訂單或賬戶SecretId | 查看API密鑰信息 |
| secret_token | 是 | 與SecretId對應(yīng)的密鑰令牌 | 通過獲得密鑰令牌接口得到的令牌 |
3. 調(diào)用示例
假定您正常使用的SecretId和SecretToken如下:
- SecretId:
o1fjh1re9o28876h7c08 - SecretToken:
oxf0n0g59h7wcdyvz2uo68ph2s
調(diào)用示例
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
使用說明
點(diǎn)擊查看關(guān)于API授權(quán)與驗(yàn)證的介紹
4. 返回結(jié)果
接口返回json格式,樣例:
令牌有效期5分鐘以上則返回:
{
"code": 0,
"msg": "ok",
"data": {
"expire": 1650
}
}
令牌距離到期不足5分鐘則返回:
{
"code": -5,
"msg": "expiring",
"data": {
"expire": 240
}
}
令牌已過期則返回:
{
"code": -107,
"msg": "expired",
"data": {
"expire": 0
}
}
字段說明如下:
| 參數(shù) | 說明 |
|---|---|
| code | 返回碼。取值:0代表令牌有效 非0代表需要重新獲得令牌 |
| msg | 錯誤信息 |
| data.expire | 密鑰令牌距離過期的剩余時長(單位:秒) |
5. 錯誤碼一覽
| 錯誤碼 | 說明 |
|---|---|
| -1 | 缺少參數(shù) |
| -2 | secret_id / secret_token參數(shù)錯誤 |
| -5 | 令牌距離到期不足5分鐘 |
| -107 | 令牌已過期 |
6. SDK
快代理提供了配套的開發(fā)工具集(SDK),支持多種編程語言,能更方便的調(diào)用 API。