獲取隧道代理IP
1. 接口描述
https://tps.kdlapi.com/api/gettps 英文代號：get tps
獲取訂單對應(yīng)的隧道代理host:port。
- 必須使用訂單API密鑰調(diào)用本接口
- 接口最快調(diào)用頻率: 1秒10次
開發(fā)提示
隧道代理的使用方式是在軟件或程序中設(shè)置代理host直接使用，無需通過API提取IP，也無需處理換IP的邏輯。
如果您只能通過API提取代理，此接口可以滿足這個需求，但請注意調(diào)用頻率限制。
2. 參數(shù)說明
| 參數(shù) | 是否必填 | 參數(shù)說明 | 取值說明 |
|---|---|---|---|
| secret_id | 是 | 訂單SecretId | 查看訂單API密鑰信息 |
| sign_type | 否 | 簽名驗證方式。目前支持token和hmacsha1。 | 默認值：token |
| signature | 是 | 請求簽名，用來驗證此次請求的合法性。 此接口默認需要驗證簽名 |
支持2種簽名驗證方式，簽名計算方法參見API 授權(quán)與驗證 |
| timestamp | 否 | 當前 UNIX 時間戳（秒級），可記錄發(fā)起 API 請求的時間。 sign_type=hmacsha1時此參數(shù)有效且為必填項。 |
例如1557546010，如果與當前時間相差過大，會引起簽名過期錯誤。 |
| nonce | 否 | 隨機正整數(shù)，與 timestamp 聯(lián)合起來，用于防止重放攻擊。建議攜帶此參數(shù)進一步提升API安全性。 sign_type=hmacsha1時此參數(shù)有效。 |
客戶自行生成隨機正整數(shù)，如random.randint(1, 100000000) |
| num | 是 | 提取數(shù)量 | 取值固定為1 |
| format | 否 | 接口返回內(nèi)容的格式 | text: 文本格式(默認) json: json格式 xml : xml格式 |
| sep | 否 | 提取結(jié)果列表中每個結(jié)果的分隔符 | 1: \r\n分隔(默認) 2: \n分隔 3: 空格分隔 4: |分隔 |
3. 調(diào)用示例
在會員中心API密鑰管理頁得到訂單的SecretId和SecretKey：
- SecretId：
o1fjh1re9o28876h7c08 - SecretKey：
jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
以密鑰令牌驗證為例，調(diào)用獲取密鑰令牌接口得到密鑰令牌：
- SecretToken：
oxf0n0g59h7wcdyvz2uo68ph2s
調(diào)用示例
num取值固定為1，不設(shè)置其他參數(shù)
GET https://tps.kdlapi.com/api/gettps?secret_id=o1fjh1re9o28876h7c08
&num=1
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
使用說明
點擊查看關(guān)于API授權(quán)與驗證的介紹
4. 返回結(jié)果
接口可返回文本格式、json格式、xml格式，字段說明如下：
| 參數(shù) | 說明 |
|---|---|
| code | 返回碼。取值：0代表成功 非0代表失敗 |
| msg | 錯誤信息 |
| data | 包含接口返回的數(shù)據(jù) |
| data.proxy_list | 返回的代理ip列表 |
| data.count | 返回的代理ip數(shù)量 |
文本格式
正常返回代理列表，代理分隔符參見sep參數(shù)，代理格式 ip:port
格式樣例：
tps121.kdlapi.com:15818
異常返回錯誤碼和錯誤提示，格式 ERROR(錯誤碼): 錯誤提示
格式樣例：
ERROR(-1): 參數(shù)錯誤
json格式
正常返回格式樣例：
{
"msg": "",
"code": 0,
"data": {
"count": 1,
"proxy_list": [
"tps121.kdlapi.com:15818",
]
}
}
異常返回格式樣例：
{"code": -1, "msg": "參數(shù)錯誤", "data": ""}
xml格式
正常返回格式樣例：
<?xml version="1.0" encoding="UTF-8"?>
<result>
<code>0</code>
<msg/>
<data>
<count>1</count>
<proxy_list>
<proxy>tps121.kdlapi.com:15818</proxy>
</proxy_list>
</data>
</result>
異常返回格式樣例：
<?xml version="1.0" encoding="UTF-8"?>
<result>
<code>-1</code>
<msg>參數(shù)錯誤</msg>
<data>
</data>
</result>
5. 錯誤碼一覽
| 錯誤碼 | 說明 |
|---|---|
| 2 | 訂單已過期 |
| 3 | 暫無可用代理 |
| 4 | 賬號尚未通過實名認證 |
| -1 | 無效請求 |
| -2 | 訂單無效。如果剛下單，請耐心等待一會兒，1分鐘內(nèi)訂單會自動生效。 |
| -3 | 參數(shù)錯誤 |
| -4 | 提取失敗: $err_msg |
| -5 | 此訂單不能提取隧道代理。 |
| -51 | 此訂單1分鐘內(nèi)允許最多$ip_number個ip調(diào)用 |
| -16 | 訂單已退款 |
| -15 | 訂單已過期 |
| -14 | 訂單被封禁，請聯(lián)系客服處理 |
| -13 | 訂單已過期 |
| -12 | 訂單無效 |
| -11 | 訂單尚未支付 |
6. 生成API鏈接
您可以在線生成API鏈接，以便內(nèi)置到您的程序或軟件中。
生成API鏈接
7. SDK
快代理提供了配套的開發(fā)工具集（SDK），支持多種編程語言，能更方便的調(diào)用 API。