欢迎来到帮助中心

  • 期待为您提供最优质的服务

代理IP API接入指南

更新时间:2019-11-19 18:24:03

请使用合理的频率去调用API接口,暴力调用将导致您的客户端IP被防火墙封禁。

1 获取代理IP

建议每隔10秒一次调用,以及时获取更新的代理IP。

1.1 接口说明

调用说明
属性 内容
URL https://api.xiaoxiangdaili.com/ip/get
方法 GET
编码 utf-8
参数说明

appKey:应用id

appSecret:应用密码

cnt(可选):提取数量,默认值为应用的最大可提取数

wt(可选):响应体格式,"json"或者"text",默认值"json"

method(可选):代理方式,"http" 或 "s5"(s5 即 socks5),默认值"http"

province(可选,仅在按量计费的情况下有效):省份

city(可选,仅在按量计费的情况下有效):城市

releaseAuto(可选,仅静态IP应用下有效):是否自动释放旧的IP

响应 类型为text文本的响应体为{ip}:{port}格式,每行一个。
类型为JSON格式的响应字段如下:
code:状态码;
success: 成功标记;
msg:描述信息;
data:数据体;
ip:ip地址;
port:端口;
realIp:隧道代理的出口IP;
during:存活期限(分钟);
状态码 200:获取成功;
1001:应用不存在;
1002:应用已被冻结或禁用;
1003:应用已过期;
1004:连接池无响应;
1005:应用不存在或已过期;
1006:应用授权验证未通过;
1007:提取量超过限制;
1008:绑定的IP不一致;
1009:无效的代理;
1010:请求过于频繁;
1012:产品类型不匹配;
1014:应用剩余量不足;
1200:参数格式错误;
2000:未知异常。

1.2 接口示例

请求:

    GET /ip/get?appKey=445153&appSecret=WfLHaF0L&cnt=20&wt=json
    Host: api.xiaoxiangdaili.com

响应:

    {
        "code": 200,
        "success": true,
        "data": [
            {
                "ip": "60.179.239.130",
                "port": 3000,
                "realIp": null,
                "during": 2
            },
            {
                "ip": "121.228.80.144",
                "port": 3000,
                "realIp": null,
                "during": 2
            },
            ...
        ],
        "msg": "操作成功"
    }

2 自动绑定终端IP

该接口适用于不具备固定出口IP的网络环境,在您的客户端上调用该接口即可自动绑定它当前的出口IP,建议每2分钟调用一次。

2.1 接口说明

调用说明
属性 内容
URL https://api.xiaoxiangdaili.com/app/bindIp
方法 GET
编码 utf-8
参数说明 appKey:应用id;
appSecret:应用密码;
i:可指定绑定第几个客户端,默认为1。不允许超过当前可绑定的 ip上限(当前限制为 5)。
响应 code:状态码;success: 成功标记
错误编号 200:绑定成功;
400:绑定失败;
1001:应用不存在;
1002:应用已被冻结或禁用;
1101:IP已被绑定;
1103:IP绑定中;
2000:未知异常。

2.2 接口示例

请求:

    GET /app/bindIp?appKey=445153&appSecret=WfLHaF0L&i=1
    Host: api.xiaoxiangdaili.com

响应:

    {
        "code": 200,
        "success": true,
        "data": null,
        "msg": "绑定成功"
    }

3 查询剩余量(按量计费)

按量计费套餐查询剩余可提取IP数量

3.1 接口说明

调用说明
属性 内容
URL https://api.xiaoxiangdaili.com/ip/remaining
方法 GET
编码 utf-8
参数说明

appKey:应用id;appSecret:应用密码;

响应 code:状态码
success: 成功标记
data:数据体;
appKey:应用id;
total:总量;
remaining:剩余量;
状态码 200:获取成功;
1102:结算类型不匹配(不是按量计费);
1001:应用不存在;
1006:应用授权验证未通过;
2000:未知异常。

3.2 接口示例

请求:

    GET /ip/remaining?appKey=445153&appSecret=WfLHaF0L
    Host: api.xiaoxiangdaili.com

响应:

    {
        "code": 200,
        "success": true,
        "data": {
            "appKey": 445153,
            "total": 500,
            "remaining": 260
        },
        "msg": "操作成功"
    }

4 释放IP(静态代理)

静态代理主动释放(解绑)当前IP

4.1 接口说明

调用说明
属性 内容
URL https://api.xiaoxiangdaili.com/ip/release
方法 POST
编码 utf-8
参数说明 appKey:应用id;
appSecret:应用密码;
proxy:需要主动释放的 IP,格式为 {ip}:{port}
响应 code:状态码;success: 成功标记
状态码 200:释放成功;
1001:应用不存在;
1006:应用授权验证未通过;
2000:未知异常。

4.2 接口示例

请求:

    POST /ip/release?appKey=445153&appSecret=WfLHaF0L&proxy=119.168.2.3:1234
    Host: api.xiaoxiangdaili.com

响应:

    {
        "code": 200,
        "success": true,
        "data": null,
        "msg": "119.168.2.3:1234 已释放"
    }

logo

欢迎注册小象代理

已经有账户了?

找回密码

已经有账户了?