API接入指南
代理IP API接入指南
1 获取代理IP
建议每隔10秒一次调用,以及时获取更新的代理IP。(可进入后台对应的产品管理页面,点击提取链接按钮进入API提取链接生成页面进行生成)
1.1 接口说明
URL
方法
编码
参数说明
appKey:应用id
appSecret:应用密码
cnt(可选):提取数量,默认值为应用的最大可提取数
wt(可选):响应体格式,"json"或者"text",默认值"json"
method(可选):代理方式,"http" 或 "s5"(s5 即 socks5),默认值"http"
releaseAuto(可选,仅长效IP应用下有效):是否自动释放旧的IP
响应
类型为text文本的响应体为{ip}:{port}格式,每行一个。
类型为JSON格式的响应字段如下:
code:状态码;
success: 成功标记;
msg:描述信息;
data:数据体;
ip:ip地址;
port:端口;
realIp:隧道代理的出口IP;
during:存活期限(分钟);
startTime:代理IP上线时间;
状态码
200:获取成功;
1001:应用不存在;
1002:应用已被冻结或禁用;
1003:应用已过期;
1004:连接池无响应;
1005:应用不存在或已过期;
1006:应用授权验证未通过;
1007:提取量超过限制;
1008:绑定的IP不一致;
1009:无效的代理;
1010:请求过于频繁;
1012:产品类型不匹配;
1014:应用剩余量不足;
1200:参数格式错误;
2000:未知异常。
1.2 接口示例
请求:
Host: api.xiaoxiangdaili.com
响应:
{ "code": 200, "success": true, "data": [ { "ip": "60.179.239.130", "port": 3000, "realIp": null, "startTime":"2022-01-01 18:00:00", "during": 2 }, { "ip": "121.228.80.144", "port": 3000, "realIp": null, "startTime":"2022-01-01 18:00:00", "during": 2 } ], "msg": "操作成功" }
2 查询剩余量
指定应用下,获取该应用可提取IP的剩余数量,限定按量计费套餐。
2.1 接口说明
URL
方法
编码
参数说明
appKey:应用id;
appSecret:应用密码;
响应
code:状态码;
success: 成功标记
appKey: 应用id
total: 总量
remaining: 剩余量
状态码
200:绑定成功;
400:绑定失败;
1001:应用不存在;
1002:应用已被冻结或禁用;
1101:IP已被绑定;
1103:IP绑定中;
2000:未知异常。
2.2 接口示例
请求:
Host: api.xiaoxiangdaili.com
响应:
{ "code": 200, "success": true, "data": { "appKey": 445153, "total": 500, "remaining": 260 }, "msg": "操作成功" }
3 释放长效代理IP
指定应用下,主动释放(解绑)当前代理IP,限定长效代理。
3.1 接口说明
URL
方法
编码
参数说明
appKey:应用id;
appSecret:应用密码;
proxy:需要主动释放的 IP,格式为 {ip}:{port}
响应
code:状态码;success: 成功标记
状态码
200:释放成功;
1001:应用不存在;
1006:应用授权验证未通过;
2000:未知异常。
3.2 接口示例
请求:
Host: api.xiaoxiangdaili.com
响应:
{ "code": 200, "success": true, "data": null, "msg": "119.168.2.3:1234 已释放" }
4 查询使用中的IP
指定应用下,获取该应用当前使用的代理IP,限定长效代理。
4.1 接口说明
URL
方法
编码
参数说明
appKey:应用id;
appSecret:应用密码;
响应
code:状态码;success: 成功标记
状态码
200:获取成功;
1001:应用不存在;
1002:应用已被冻结或禁用;
1003:应用已过期;
1004:连接池无响应;
1005:应用不存在或已过期;
1006:应用授权验证未通过;
1009:无效的代理;
1012:产品类型不匹配;
1018:代理池不匹配;
1019:当前代理IP无效;
2000:未知异常。
4.2 接口示例
请求:
Host: api.xiaoxiangdaili.com
响应:
{ "code": 200, "success": true, "data": [], "msg": "操作成功" }
5 查询长效IP状态
指定应用下,获取该应用当前使用代理IP的释放状态,限定长效代理。
5.1 接口说明
URL
方法
编码
参数说明
appKey:应用id;
appSecret:应用密码;
proxy:需要主动释放的 IP,格式为 {ip}:{port}
响应
code:状态码;success: 成功标记
状态码
200:查询成功;
1001:应用不存在;
1002:应用已被冻结或禁用;
1003:应用已过期;
1005:应用不存在或已过期;
1006:应用授权验证未通过;
1009:无效的代理;
1012:产品类型不匹配;
1018:代理池不匹配;
1019:当前代理IP无效;
1201:参数格式错误;
2000:未知异常。
5.2 接口示例
请求:
Host: api.xiaoxiangdaili.com
响应:
{ "code": 200, "success": true, "data": null, "msg": "暂无承载数据" }
6 自动绑定白名单
该接口适用于不具备固定出口IP的网络环境,在您的客户端上调用该接口即可自动绑定它当前的出口IP,建议每2分钟调用一次。
6.1 接口说明
URL
方法
编码
参数说明
appKey:应用id;
appSecret:应用密码;
i:可指定绑定第几个客户端,默认为1。不允许超过当前可绑定的 ip上限(当前限制为 5)。
响应
code:状态码;success: 成功标记
状态码
200:绑定成功;
400:绑定失败;
1001:应用不存在;
1002:应用已被冻结或禁用;
1101:IP已被绑定;
1103:IP绑定中;
2000:未知异常。
6.2 接口示例
请求:
Host: api.xiaoxiangdaili.com
响应:
{ "code": 200, "success": true, "data": null, "msg": "绑定成功" }
7 获取已绑定白名单
指定应用下,获取该应用已经绑定的白名单列表。
7.1 接口说明
URL
方法
编码
参数说明
appKey:应用id;
appSecret:应用密码;
响应
code:状态码;
success: 成功标记
limit: 白名单数量限制
bindIpsList: 绑定列表
count: 绑定数量
状态码
200:查询成功;
1001:应用不存在;
1002:应用已被冻结或禁用;
1003:应用已过期;
1005:应用不存在或已过期;
1006:应用授权验证未通过;
1009:无效的代理;
1012:产品类型不匹配;
1018:代理池不匹配;
1019:当前代理IP无效;
2000:未知异常。
7.2 接口示例
请求:
Host: api.xiaoxiangdaili.com
响应:
{ "code": 200, "success": true, "data": {"limit":5,"bindIpsList":[],"count":0}, "msg": "操作成功" }
8 获取应用到期时间
指定应用下,获取该应用的到期时间。
8.1 接口说明
URL
方法
编码
参数说明
appKey:应用id;
appSecret:应用密码;
响应
code:状态码;
success: 成功标记
expireTime: 到期时间
状态码
200:查询成功;
1001:应用不存在;
1002:应用已被冻结或禁用;
1003:应用已过期;
1005:应用不存在或已过期;
1006:应用授权验证未通过;
1009:无效的代理;
1012:产品类型不匹配;
1018:代理池不匹配;
1019:当前代理IP无效;
2000:未知异常。
8.2 接口示例
请求:
Host: api.xiaoxiangdaili.com
响应:
{ "code": 200, "success": true, "data": {"expireTime":"2021-12-02 11:54:14"}, "msg": "操作成功" }
9 获取应用基本信息
指定应用下,获取该应用的基本信息。
9.1 接口说明
URL
方法
编码
参数说明
appKey:应用id;
appSecret:应用密码;
响应
code:状态码;
success: 成功标记
appKey: 应用id
appType: 产品类型
settleType: 结算类型
startTime: 开通时间
endTime: 到期时间
quantity: 按量应用的ip总量
remain: 按量应用的ip使用量
perLimit: 单次提取量
dayLimit: 每天提取量
bindIp: 白名单绑定IP
bindNum: 允许白名单绑定数量
autoBindIp: 是否自动绑定ip
multiClientEnabled: 是否开启多客户端调用支持
requestFreq: 调用间隔(秒)
状态码
200:查询成功;
1001:应用不存在;
1002:应用已被冻结或禁用;
1003:应用已过期;
1005:应用不存在或已过期;
1006:应用授权验证未通过;
1009:无效的代理;
1012:产品类型不匹配;
1018:代理池不匹配;
1019:当前代理IP无效;
2000:未知异常。
9.2 接口示例
请求:
Host: api.xiaoxiangdaili.com
响应:
{ "code": 200, "success": true, "data": { "appKey":"445153", "appType":"短效代理IP-动态2分钟", "settleType":"按时间", "startTime":"2020-11-02 11:54:14", "endTime":"2099-12-02 11:54:14", "quantity":null, "remain":null, "perLimit":50, "dayLimit":5000, "bindIp":",_,_,_,_,_,", "bindNum":5, "autoBindIp":true, "multiClientEnabled":false, "requestFreq":null }, "msg": "操作成功" }
10 获取账户钱包余额
指定应用下,获取该应用账户钱包当前的余额。
10.1 接口说明
URL
方法
编码
参数说明
appKey:应用id;
appSecret:应用密码;
响应
code:状态码;
success: 成功标记
balance: 余额
状态码
200:查询成功;
1001:应用不存在;
1002:应用已被冻结或禁用;
1003:应用已过期;
1005:应用不存在或已过期;
1006:应用授权验证未通过;
1009:无效的代理;
1012:产品类型不匹配;
1018:代理池不匹配;
1019:当前代理IP无效;
2000:未知异常。
10.2 接口示例
请求:
Host: api.xiaoxiangdaili.com
响应:
{ "code": 200, "success": true, "data": {"balance":"75043000"}, "msg": "操作成功" }