獲取隧道代理IP

1. 接口描述

https://tps.kdlapi.com/api/gettps 英文代號(hào)：get tps

獲取訂單對(duì)應(yīng)的隧道代理host:port。

必須使用訂單API密鑰調(diào)用本接口
接口最快調(diào)用頻率: 1秒10次

開(kāi)發(fā)提示

隧道代理的使用方式是在軟件或程序中設(shè)置代理host直接使用，無(wú)需通過(guò)API提取IP，也無(wú)需處理?yè)QIP的邏輯。
如果您只能通過(guò)API提取代理，此接口可以滿足這個(gè)需求，但請(qǐng)注意調(diào)用頻率限制。

2. 參數(shù)說(shuō)明

參數(shù)	是否必填	參數(shù)說(shuō)明	取值說(shuō)明
secret_id	是	訂單SecretId	查看訂單API密鑰信息
sign_type	否	簽名驗(yàn)證方式。目前支持token和hmacsha1。	默認(rèn)值：token
signature	是	請(qǐng)求簽名，用來(lái)驗(yàn)證此次請(qǐng)求的合法性。此接口默認(rèn)需要驗(yàn)證簽名	支持2種簽名驗(yàn)證方式，簽名計(jì)算方法參見(jiàn)API 授權(quán)與驗(yàn)證
timestamp	否	當(dāng)前 UNIX 時(shí)間戳（秒級(jí)），可記錄發(fā)起 API 請(qǐng)求的時(shí)間。 sign_type=hmacsha1時(shí)此參數(shù)有效且為必填項(xiàng)。	例如1557546010，如果與當(dāng)前時(shí)間相差過(guò)大，會(huì)引起簽名過(guò)期錯(cuò)誤。
nonce	否	隨機(jī)正整數(shù)，與 timestamp 聯(lián)合起來(lái)，用于防止重放攻擊。建議攜帶此參數(shù)進(jìn)一步提升API安全性。 sign_type=hmacsha1時(shí)此參數(shù)有效。	客戶(hù)自行生成隨機(jī)正整數(shù)，如random.randint(1, 100000000)
num	是	提取數(shù)量	取值固定為1
format	否	接口返回內(nèi)容的格式	text: 文本格式(默認(rèn)) json: json格式 xml : xml格式
sep	否	提取結(jié)果列表中每個(gè)結(jié)果的分隔符	1: \r\n分隔(默認(rèn)) 2: \n分隔 3: 空格分隔 4: \|分隔
generateType	否	接口返回內(nèi)容和格式	1: 代理服務(wù)器:端口:代理用戶(hù)名:代理密碼(默認(rèn)) 2: 代理服務(wù)器:端口@代理用戶(hù)名:代理密碼 3: 代理用戶(hù)名:代理密碼:代理服務(wù)器:端口 4: 代理用戶(hù)名:代理密碼@代理服務(wù)器:端口

3. 調(diào)用示例

在會(huì)員中心API密鑰管理頁(yè)得到訂單的SecretId和SecretKey：

SecretId：o1fjh1re9o28876h7c08
SecretKey：jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

以密鑰令牌驗(yàn)證為例，調(diào)用獲取密鑰令牌接口得到密鑰令牌：

SecretToken：oxf0n0g59h7wcdyvz2uo68ph2s

調(diào)用示例

num取值固定為1，不設(shè)置其他參數(shù)

GET https://tps.kdlapi.com/api/gettps?secret_id=o1fjh1re9o28876h7c08
&num=1
&signature=oxf0n0g59h7wcdyvz2uo68ph2s

使用說(shuō)明

點(diǎn)擊查看關(guān)于API授權(quán)與驗(yàn)證的介紹

4. 返回結(jié)果

接口可返回文本格式、json格式、xml格式，字段說(shuō)明如下：

參數(shù)	說(shuō)明
code	返回碼。取值：0代表成功非0代表失敗
msg	錯(cuò)誤信息
data	包含接口返回的數(shù)據(jù)
data.proxy_list	返回的代理ip列表
data.count	返回的代理ip數(shù)量

文本格式

正常返回代理列表，代理分隔符參見(jiàn)sep參數(shù)，代理格式 ip:port
格式樣例：

tps121.kdlapi.com:15818

異常返回錯(cuò)誤碼和錯(cuò)誤提示，格式 ERROR(錯(cuò)誤碼): 錯(cuò)誤提示
格式樣例：

ERROR(-1): 參數(shù)錯(cuò)誤

json格式

正常返回格式樣例：

{
  "msg": "",
  "code": 0,
  "data": {
    "count": 1,
    "proxy_list": [
      "tps121.kdlapi.com:15818",
    ]
  }
}

異常返回格式樣例：

{"code": -1, "msg": "參數(shù)錯(cuò)誤", "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ù)錯(cuò)誤</msg>
  <data>
  </data>
</result>

5. 錯(cuò)誤碼一覽

錯(cuò)誤碼	說(shuō)明
2	訂單已過(guò)期
3	暫無(wú)可用代理
4	賬號(hào)尚未通過(guò)實(shí)名認(rèn)證
-1	無(wú)效請(qǐng)求
-2	訂單無(wú)效。如果剛下單，請(qǐng)耐心等待一會(huì)兒，1分鐘內(nèi)訂單會(huì)自動(dòng)生效。
-3	參數(shù)錯(cuò)誤
-4	提取失敗: $err_msg
-5	此訂單不能提取隧道代理。
-51	此訂單1分鐘內(nèi)允許最多$ip_number個(gè)ip調(diào)用
-16	訂單已退款
-15	訂單已過(guò)期
-14	訂單被封禁，請(qǐng)聯(lián)系客服處理
-13	訂單已過(guò)期
-12	訂單無(wú)效
-11	訂單尚未支付

6. 生成API鏈接

您可以在線生成API鏈接，以便內(nèi)置到您的程序或軟件中。
生成API鏈接

7. SDK

快代理提供了配套的開(kāi)發(fā)工具集（SDK），支持多種編程語(yǔ)言，能更方便的調(diào)用 API。

SDK下載