獲得密鑰令牌
1. 接口描述
https://auth.kdlapi.com/api/get_secret_token 英文代號(hào):get secret token
通過(guò)API密鑰獲得接口驗(yàn)證所需的令牌。
- 當(dāng)前令牌沒(méi)失效之前調(diào)用本接口仍返回當(dāng)前令牌
- 調(diào)用本接口時(shí)如果當(dāng)前令牌還剩5分鐘到期,會(huì)生成并返回新的令牌,舊令牌仍會(huì)自然到期失效
- 令牌默認(rèn)有效期為60分鐘,您可在API設(shè)置頁(yè)更改
- 本接口只支持HTTP POST請(qǐng)求
- 接口最快調(diào)用頻率: 1秒1次
安全提示
因secret_key在網(wǎng)絡(luò)中頻繁傳輸會(huì)增加泄露風(fēng)險(xiǎn),故不建議頻繁調(diào)用此接口。
建議您獲得secret_token后本地存儲(chǔ),減少調(diào)用頻率。
可調(diào)用檢測(cè)密鑰令牌接口實(shí)時(shí)檢測(cè)secret_token的剩余有效時(shí)長(zhǎng)。
2. 參數(shù)說(shuō)明
| 參數(shù) | 是否必填 | 參數(shù)說(shuō)明 | 取值說(shuō)明 |
|---|---|---|---|
| secret_id | 是 | 訂單或賬戶(hù)SecretId | 查看API密鑰信息 |
| secret_key | 是 | 訂單或賬戶(hù)SecretKey | 查看API密鑰信息 |
3. 調(diào)用示例
在會(huì)員中心API密鑰管理頁(yè)得到訂單或賬戶(hù)的SecretId和SecretKey:
- SecretId:
o1fjh1re9o28876h7c08 - SecretKey:
jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
調(diào)用示例
POST https://auth.kdlapi.com/api/get_secret_token HTTP/1.1
Content-Type: application/x-www-form-urlencoded
secret_id=o1fjh1re9o28876h7c08&secret_key=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
使用說(shuō)明
點(diǎn)擊查看關(guān)于API授權(quán)與驗(yàn)證的介紹
4. 返回結(jié)果
接口返回json格式,樣例:
{
"code": 0,
"msg": "success",
"data": {
"secret_token": "oxf0n0g59h7wcdyvz2uo68ph2s",
"expire": 3600
}
}
字段說(shuō)明如下:
| 參數(shù) | 說(shuō)明 |
|---|---|
| code | 返回碼。取值:0代表成功 非0代表失敗 |
| msg | 錯(cuò)誤信息 |
| data.secret_token | 密鑰令牌 |
| data.expire | 密鑰令牌的有效期,即距離過(guò)期的剩余時(shí)長(zhǎng)(單位:秒) |
5. 錯(cuò)誤碼一覽
| 錯(cuò)誤碼 | 說(shuō)明 |
|---|---|
| -1 | 缺少參數(shù) |
| -2 | secret_id / secret_key參數(shù)錯(cuò)誤 |
6. SDK
快代理提供了配套的開(kāi)發(fā)工具集(SDK),支持多種編程語(yǔ)言,能更方便的調(diào)用 API。