獲取隧道代理Pro城市編碼
1. 接口描述
https://tps.kdlapi.com/api/gettpscitycode 英文代號:get tps city code
- 支持訂單或賬戶API密鑰調(diào)用本接口
- 接口最快調(diào)用頻率:1秒1次
2. 參數(shù)說明
| 參數(shù) | 是否必填 | 參數(shù)說明 | 取值說明 |
|---|---|---|---|
| secret_id | 是 | 訂單或賬戶SecretId | 查看API密鑰信息 |
| sign_type | 否 | 簽名驗證方式。目前支持token和hmacsha1。 | 默認(rèn)值:token |
| signature | 是 | 請求簽名,用來驗證此次請求的合法性。 | 支持2種簽名驗證方式,簽名計算方法參見API 授權(quán)與驗證 |
| timestamp | 否 | 當(dāng)前 UNIX 時間戳(秒級),可記錄發(fā)起 API 請求的時間。 sign_type=hmacsha1時此參數(shù)有效且為必填項。 |
例如1557546010,如果與當(dāng)前時間相差過大,會引起簽名過期錯誤。 |
| nonce | 否 | 隨機(jī)正整數(shù),與 timestamp 聯(lián)合起來,用于防止重放攻擊。建議攜帶此參數(shù)進(jìn)一步提升API安全性。 sign_type=hmacsha1時此參數(shù)有效。 |
客戶自行生成隨機(jī)正整數(shù),如random.randint(1, 100000000) |
| prov | 是 | 城市編碼 | 城市編碼,例如:13,14 |
3. 調(diào)用示例
在會員中心API密鑰管理頁得到訂單的SecretId和SecretKey:
- SecretId:
o1fjh1re9o28876h7c08 - SecretKey:
jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
以密鑰令牌驗證為例,調(diào)用獲取密鑰令牌接口得到密鑰令牌:
- SecretToken:
oxf0n0g59h7wcdyvz2uo68ph2s
調(diào)用示例
獲取浙江的城市編碼
GET https://tps.kdlapi.com/api/getfpsareacode?secret_id=o1fjh1re9o28876h7c08
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
&prov=33
使用說明
點擊查看關(guān)于API授權(quán)與驗證的介紹
4. 返回結(jié)果
接口返回json格式,樣例:
{
"msg": "",
"code": 0,
"data": {
"杭州市": "330100",
"寧波市": "330200",
"溫州市": "330300",
"嘉興市": "330400",
"湖州市": "330500",
"紹興市": "330600",
"金華市": "330700",
"衢州市": "330800",
"舟山市": "330900",
"臺州市": "331000",
"麗水市": "331100"
}
}
異常返回格式樣例:
{"code": -1, "msg": "參數(shù)錯誤", "data": ""}
輸入的國家查詢不到編碼時返回:
{ "msg": "", "code": 0, "data": [] }
5. 錯誤碼一覽
| 錯誤碼 | 說明 |
|---|---|
| -1 | 缺少參數(shù) |
6. SDK
快代理提供了配套的開發(fā)工具集(SDK),支持多種編程語言,能更方便的調(diào)用 API。