获取隧道代理IP

1. 接口描述

http://tps.kdlapi.com/api/gettps 英文代号:get tps

获取订单对应的隧道代理IP。

  1. HTTP GET接口
  2. 参数和返回内容均采用utf-8编码
  3. 接口最快调用频率: 1秒10次
  4. 接口IP白名单数量(同时允许调用此接口的IP数量)固定为10个

温馨提示

隧道代理主流的使用方式是在软件或程序中设置代理直接使用,无需通过API提取IP,也无需处理换IP的逻辑。
部分客户仍希望用传统方式先通过API提取代理IP,此接口可以满足这个需求。

2. 参数说明

参数 是否必填 参数说明 取值说明
orderid 订单号 有效的隧道代理订单号。查看我的订单
sign_type 签名验证方式。目前支持simple和hmacsha1。 默认值:simple
signature 请求签名,用来验证此次请求的合法性。
此接口默认不需要验证签名,但在会员中心开启验证后此参数则为必填项。
支持2种签名验证方式,签名计算方法参见API 授权与验证
timestamp 当前 UNIX 时间戳(秒级),可记录发起 API 请求的时间。
sign_type=hmacsha1时此参数为必填项。
例如1557546010,如果与当前时间相差过大,会引起签名过期错误。
num 提取数量 例如:1
format 接口返回内容的格式 text: 文本格式(默认)
json: json格式
xml : xml格式
sep 提取结果列表中每个结果的分隔符 1: \r\n分隔(默认)
2: \n分隔
3: 空格分隔
4: |分隔

3. 返回值

接口可返回文本格式、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>
    <proxylist>
      <proxy>tps121.kdlapi.com:15818</proxy>
    </proxylist>
  </data>
</result>

异常返回格式样例:

<?xml version="1.0" encoding="UTF-8"?>
<result>
  <code>-1</code>
  <msg>参数错误</msg>
  <data>
  </data>
</result>

4. 错误码一览

错误码 说明
2 订单已过期
3 暂无可用代理
-1 无效请求
-2 订单无效。如果刚下单,请耐心等待一会儿,3分钟内系统会自动发货。
-3 参数错误
-4 提取失败: $err_msg
-5 此订单不能提取隧道代理。
-51 此订单1分钟内允许最多$ip_number个ip调用
-16 订单已退款
-15 订单已过期
-14 订单被封禁,请联系客服处理
-13 订单已过期
-12 订单无效
-11 订单尚未支付

5. 示例

订单号:965102959536478

调用示例

orderid=965102959536478num=1&拼接起来作为参数即可生成API链接:

http://tps.kdlapi.com/api/gettps?orderid=965102959536478&num=1

返回示例

tps121.kdlapi.com:15818

6. 生成API链接

您可以在线生成API链接,以便内置到您的程序或软件中。
生成API链接

7. SDK

快代理提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

SDK下载

联系我们
  • 售前在线咨询
    咨询享免费测试,专业工程师提供技术支持
  • 客服热线
    400-058-0638  周一至周六 9:00-18:00
  • 提交工单
    您的每一次反馈我们都认真对待
  • 客服微信 & QQ
    客服微信:kuaidaili,客服QQ:800849628
  • 企业客户通道
    提交需求后专业的售前工程师为您提供服务