获取隧道代理ProIP
1. 接口描述
https://tps.kdlapi.com/api/gettpspro 英文代号:get tps
获取订单对应的隧道代理Prohost:port
。
- 必须使用订单API密钥调用本接口
- 接口最快调用频率: 1秒10次
开发提示
隧道代理Pro的使用方式是在软件或程序中设置代理host直接使用,无需通过API提取IP,也无需处理换IP的逻辑。
如果您只能通过API提取代理,此接口可以满足这个需求,但请注意调用频率限制。
2. 参数说明
参数 | 是否必填 | 参数说明 | 取值说明 |
---|---|---|---|
secret_id | 是 | 订单SecretId | 查看订单API密钥信息 |
sign_type | 否 | 签名验证方式。目前支持token和hmacsha1。 | 默认值:token |
signature | 是 | 请求签名,用来验证此次请求的合法性。 此接口默认需要验证签名 |
支持2种签名验证方式,签名计算方法参见API 授权与验证 |
timestamp | 否 | 当前 UNIX 时间戳(秒级),可记录发起 API 请求的时间。 sign_type=hmacsha1时此参数为必填项。 |
例如1557546010,如果与当前时间相差过大,会引起签名过期错误。 |
nonce | 否 | 随机正整数,与 timestamp 联合起来,用于防止重放攻击。建议携带此参数进一步提升API安全性。 sign_type=hmacsha1时此参数有效。 |
客户自行生成随机正整数,如random.randint(1, 100000000) |
num | 是 | 提取数量 | 取值固定为1 |
pt | 否 | 提取的代理ip类型 | 1: http代理(默认) 2: socks代理 |
format | 否 | 接口返回内容的格式 | text: 文本格式(默认) json: json格式 xml : xml格式 |
sep | 否 | 提取结果列表中每个结果的分隔符 | 1: \r\n分隔(默认) 2: \n分隔 3: 空格分隔 4: |分隔 |
3. 调用示例
在会员中心API密钥管理页得到订单的SecretId和SecretKey:
- SecretId:
o1fjh1re9o28876h7c08
- SecretKey:
jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
以密钥令牌验证为例,调用获取密钥令牌接口得到密钥令牌:
- SecretToken:
oxf0n0g59h7wcdyvz2uo68ph2s
调用示例
num取值固定为1,不设置其他参数
GET https://tps.kdlapi.com/api/gettpspro?secret_id=o1fjh1re9o28876h7c08
&num=1
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
使用说明
点击查看关于API授权与验证的介绍
4. 返回结果
接口可返回文本格式、json格式、xml格式,字段说明如下:
参数 | 说明 |
---|---|
code | 返回码。取值:0代表成功 非0代表失败 |
msg | 错误信息 |
data | 包含接口返回的数据 |
data.proxy_list | 返回的代理ip列表 |
data.count | 返回的代理ip数量 |
文本格式
正常返回代理列表,代理分隔符参见sep
参数,代理格式 ip:port
格式样例:
tps121.kdlapi.com:15818
异常返回错误码和错误提示,格式 ERROR(错误码): 错误提示
格式样例:
ERROR(-1): 参数错误
json格式
正常返回格式样例:
{
"msg": "",
"code": 0,
"data": {
"count": 1,
"proxy_list": [
"tps121.kdlapi.com:15818",
]
}
}
异常返回格式样例:
{"code": -1, "msg": "参数错误", "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>参数错误</msg>
<data>
</data>
</result>
5. 错误码一览
错误码 | 说明 |
---|---|
2 | 订单已过期 |
3 | 暂无可用代理 |
4 | 账号尚未通过实名认证 |
-1 | 无效请求 |
-2 | 订单无效。如果刚下单,请耐心等待一会儿,1分钟内订单会自动生效。 |
-3 | 参数错误 |
-4 | 提取失败: $err_msg |
-5 | 此订单不能提取隧道代理Pro。 |
-51 | 此订单1分钟内允许最多$ip_number个ip调用 |
-16 | 订单已退款 |
-15 | 订单已过期 |
-14 | 订单被封禁,请联系客服处理 |
-13 | 订单已过期 |
-12 | 订单无效 |
-11 | 订单尚未支付 |
6. 生成API链接
您可以在线生成API链接,以便内置到您的程序或软件中。
生成API链接
7. SDK
快代理提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。