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