接口地址: https://proxy.zzqidc.com/monopolize_resources
本接口是用于获取用户已占用到且可用的独占资源列表。
请求频率限制:60次/分钟;
方法:GET;
编码:参数和返回内容均采用utf-8编码。
参数名 | 是否必选 | 类型 | 描述 |
---|---|---|---|
Key | 是 | String | 查询独占资源的Key值; |
UUIDs | 否 | String | 独占资源编号,多个用逗号隔开。 |
接口可返回文本格式、json格式、xml格式,字段说明如下:
返回字段 | 类型 | 描述 |
---|---|---|
data | Array | 独占资源列表 |
error | String | 错误信息 |
请求接口示例:
返回示例:
{
data: [{
"uuid": "fj_qzdx9-1:ppp10",
"area": “河南省郑州市”,
"area_code": 350500,
"operator": "电信",
"operator_code": 1,
"state": 1, //已独占、排队中
"wait_seconds": 35, //排队等待秒数,已独占状态秒数为0
"monopolize_time": "2022-02-17 14:01:05", //独占时间
"last_dial_time": "2022-02-17 14:01:05", //最近一次拨号时间
"newest_ip": "127.0.0.1:10800",
"redialing": 0, //是否重拨中
"report_ts": "2022-02-17 14:01:05",
},{
...
}]
}
错误码 | 描述 |
---|---|
200 | 查询成功 |
500 | 未知错误 |
接口地址:https://proxy.zzqidc.com/replace
本接口用于替换代理IP。
该接口单个Key的请求频率限制为:(通道数*5)+10 次/分钟;
方法:HTTP、GET,需要注意不能混合使用;
编码:参数和返回内容均采用utf-8编码。
参数名 | 是否必选 | 类型 | 描述 |
---|---|---|---|
Key | 是 | String | 更换IP的Key值 |
KeepAlive | 否 | Interger | 存活周期;默认动态独享24小时,动态共享默认购买的套餐存活周期时长 |
AreaId | 否 | Interger | 区域ID;默认随机 |
ISP | 否 | Interger | 运营商ID;默认随机 |
Num | 否 | Intger | 申请数量,默认为全部 |
Detail | 否 | Interger | 详情0(关闭) 1(开启) ,默认为 0 |
Distinct | 否 | Interger | 去重0(关闭) 1(开启),默认为0 |
DataFormat | 否 | String | 数据格式,本接口取值:json、html、text ,默认为 json格式 |
DataSeparator | 否 | String | 分隔符,自定义 |
接口可返回文本格式、json格式、xml格式,字段说明如下:
参数名 | 类型 | 描述 |
---|---|---|
Code | Integer | 结果编码:0(成功)-1(失败) |
TaskID | Integer | 任务ID |
Num | Intger | 申请数量 |
Data | Array | 代理IP数据信息,包含节点IP、端口、失效日期 |
Msg | String | 区域ID |
请求接口示例:
返回示例:
{
"Code ":0,
"TaskID ":"91107E16D28AC5A",
"Num " : "1"
"Data": [
"IP ": "127.0.0.1",
"port ": "49168",
"deadline ": "2018-05-11 02:56:02",
"host ": "127.0.0.1:49168",
]
}
错误码 | 描述 |
---|---|
-1 | 未知错误 |
-10 | Authkey对应的业务无此权限 |
-11 | 请求过于频繁 |
-100 | 计划不存在或已过期 |
-101 | 请求数量超过计划通道数 |
-103 | 资源不足 |
接口地址: https://proxy.zzqidc.com/monopolize_resources
本接口是用于释放申请到的独占IP,以便于再次进行独占IP申请。
请求频率限制:按时业务是(通道数*5+10)次/分钟;
方法:DELETE;
编码:参数和返回内容均采用utf-8编码。
参数名 | 是否必选 | 类型 | 描述 |
---|---|---|---|
Key | 是 | String | 释放独占资源的Key值; |
UUIDs | 是 | String | 独占资源编号,多个用逗号隔开。 |
接口可返回文本格式、json格式、xml格式,字段说明如下:
返回字段 | 类型 | 描述 |
---|---|---|
data | Array | 释放成功的独占资源编号数组; |
error | String | 错误信息。 |
请求接口示例:
返回示例:
{
"data": ["fj_xmdx2-1:ppp10"]
}
错误码 | 描述 |
---|---|
200 | 删除成功 |
400 | 释放时间限制,申请后12小时可释放 |
500 | 未知错误 |
接口地址: https://proxy.zzqidc.com/monopolize_resources/newest_ips
本接口是用于请求重拨独占资源。
请求频率限制:按时业务是(通道数*5+10)次/分钟;
方法:PUT ;
编码:参数和返回内容均采用utf-8编码。
参数名 | 是否必选 | 类型 | 描述 |
---|---|---|---|
Key | 是 | String | 重拨独占资源的Key值; |
UUIDs | 是 | String | 独占资源编号,多个用逗号隔开。 |
接口可返回文本格式、json格式、xml格式,字段说明如下:
返回字段 | 类型 | 描述 |
---|---|---|
data | Array | 重拨成功的独占资源编号数组; |
error | String | 错误信息。 |
请求接口示例:
curl -X PUT -d 'Key=XXX&UUIDs=XXX,XXX' https://proxy.zzqidc.com/monopolize_resources/newest_ips
返回示例:
{
data: ["fj_qzdx1-2:ppp1"] //重拨成功的资源uuids
}
错误码 | 描述 |
---|---|
200 | 重拨成功 |
400 | 重拨时间间隔限制或资源还在分配中 |
500 | 未知错误 |
1.请求结构:
服务地址:目前支持的域名列表为:
接口域名 | 域名 |
---|---|
请求域名 | proxy.zzqidc.com |
2.公共参数
公共参数是用于标识用户和接口的参数,如非必要,在每个接口单独的接口文档中不再对这些参数进行说明,但每次请求均需要携带这些参数,才能正常发起请求。
参数名 | 是否必选 | 类型 | 描述 |
---|---|---|---|
Method | 是 | String | 具体操作的指令接口名称,例如想要调用查询代理IP列表接口,则Method参数即为query。 |
Key | 是 | String | 在 https://www.zzqidc.com 上购买代理IP后得到的标识身份的密钥Key。 |
Num | 否 | Integer | 数量 |
KeepAlive | 否 | Integer | 生存周期(单位分钟) |
AreaId | 否 | Integer | 区域编号(参考区域编号数据表) |
detail | 否 | Integer | 是否查看详情(可查看到具体的省市县信息) |
IP | 否 | String | 节点IP,多个以逗号“,”分割,全部以”* “表示 |
Isp | 否 | String | 运营商,多个以逗号“,”分割,默认随机 1:电信,2:移动,3:联通,4:BGP |
TaskID | 否 | String | 任务ID,多个以逗号“,”分割,全部以”* “表示 |
假设用户想要查询已申请的代理IP列表(其中Method为query),则其请求链接的形式可能如下:
https://proxy.zzqidc.com/query?Key=密钥
3.接口请求频率
接口频率限制时间均为一分钟内,从触发某个接口的时间开始计时的一分钟。具体详情如下:
接口类型 | 频率限制 |
---|---|
/allocate 申请 | 通道数*5+10 |
/release 释放 | 通道数*5 |
/query 查询 | 通道数*5+10 |
/whitelist/add 添加白名单 | 20 |
/whitelist/del 删除白名单 | 20 |
/whitelist/query 查询白名单 | 60 |
/info/quota 通道配额查询 | 60 |
/resources 资源查询 | 60 |
4.释放次数限制
套餐类型 | 释放次数限制说明 |
---|---|
动态独享 | 每分钟的释放限制次数为通道数*2 |
动态共享 | 不能自主释放,套餐时长到期后自动释放 |
静态独享 | 超过一天后能释放,一周不超过2次 |
动态独占 | 添加的资源要12小时后才能更换 |
5.通信协议
快米云代理IP-API的所有接口均支持HTTP、HTTPS进行通信,提供高安全性的通信通道。
6.请求方法
同时支持 POST 和 GET 请求,需要注意不能混合使用。即如果使用 GET 方式,则参数均从 Querystring 取得;如果使用 POST 方式,则参数均从 Request Body 中取得,Querystring 中的参数将忽略。两种方式参数格式规则相同,一般使用GET,当参数字符串过长时使用POST,请见各接口详细描述。
7.字符编码
均使用UTF-8编码。
通过编码使用动态独享代理主要有以下三步骤:
(1)先在会员中心上查看购买的动态独享代理,进行本地调试和验证;查看测试步骤>>
(2)参考代码样例请求动态独享代理;
(3)在程序中通过调用API接口获取代理,然后请求目标网站。
动态独享代理API接口一览
接口类型 | API | 描述 |
---|---|---|
资源相关 | - allocate - replace - release - query |
- 调用 allocate申请代理IP资源 - 调用replace用于释放并申请新的代理IP,更换IP资源 - 调用release释放申请到的IP,以便于再次进行IP申请 - 调用query查询用户可用的代理IP资源列表 |
白名单相关 | - whitelist/query - whitelist/add - whitelist/del |
- 调用 whitelist/query用于查询IP的白名单 - 调用whitelist/add用于添加IP的白名单 - 调用whitelist/del用于删除IP的白名单 |
资源信息查询 | - info/quota - resources |
- 调用 info/quota用于查询IP提取余量 - 调用resources查询平台可用的代理IP资源列表 |
动态独享代理只提供给单个客户使用,独占IP和带宽资源,因此新增replace、release。
通过编码使用动态独占代理主要有以下三步骤:
(1)先在会员中心上查看购买的动态独占代理,在“IP管理”中添加IP城市,获取的独占资源进行本地调试和验证;查看测试步骤>>
(2)参考代码样例请求动态独占代理;
(3)在程序中通过调用API接口获取独占代理,然后请求目标网站。
动态独占代理API接口一览
接口类型 | API | 描述 |
---|---|---|
资源相关 | - monopolize_resources - monopolize_resources - monopolize_resources - monopolize_resources/newest_ips |
- 用POST调用接口申请独占资源 -用GET调用接口查询可用的独占资源 - 用DELETE调用接口释放独占资源 - 用PUT调用接口请求重拨独占资源 |
白名单相关 | - whitelist/query - whitelist/add - whitelist/del |
- 调用接口用于查询IP的白名单 - 调用接口用于添加IP的白名单 - 调用接口用于删除IP的白名单 |
资源信息查询 | - monopolize_resources/idle | - 用GET调用接口查询空闲的独占资源 |
动态独占代理相对动态独享代理,除了可以独享宽带和IP,还可以指定城市,因此资源相关接口与其他代理都不一样。
通过编码使用静态独享代理主要有以下三步骤:
(1)先在会员中心上查看购买的静态独享代理,进行本地调试和验证;查看测试步骤>>
(2)参考代码样例请求静态独享代理;
(3)在程序中通过调用API接口获取代理,然后请求目标网站。
静态独享代理API接口一览
接口类型 | API | 描述 |
---|---|---|
资源相关 | - allocate - query - release |
- 调用 allocate申请代理IP资源 - 调用query查询IP资源池全部可用的IP信息 - 调用release释放申请到的IP,以便于再次进行IP申请。 |
白名单相关 | - whitelist/query - whitelist/add - whitelist/del |
- 调用 whitelist/query用于查询IP的白名单 - 调用whitelist/add用于添加IP的白名单 - 调用whitelist/del用于删除IP的白名单 |
资源信息查询 | - info/quota - resources |
- 调用 info/quota查询IP提取余量 - 调用extract查询平台可用的代理IP资源列表 |
通过编码使用动态共享代理主要有以下三步骤:
(1)先在提取工具或调试工具上提取动态共享代理,进行本地调试和验证;查看测试步骤>>
(2)参考代码样例请求动态共享代理;
(3)在程序中通过调用API接口获取代理,然后请求目标网站。
动态共享代理API接口一览
接口类型 | API | 描述 |
---|---|---|
资源相关 | - allocate - extract - query |
- 调用 allocate申请代理IP资源 - 调用extract获取IP资源池全部可用的IP信息 - 调用query查询用户可用的代理IP资源列表 |
白名单相关 | - whitelist/query - whitelist/add - whitelist/del |
- 调用 whitelist/query用于查询IP的白名单 - 调用whitelist/add用于添加IP的白名单 - 调用whitelist/del用于删除IP的白名单 |
资源信息查询 | - info/quota - resources |
- 调用 info/quota查询IP提取余量 - 调用resources查询平台可用的代理IP资源列表 |
需要注意的是动态共享代理区分按时业务和按量业务,按时动态共享代理的默认提取接口是extract,按量动态共享代理的默认提取接口是allocate。
快米云代理IP提供了功能丰富的API接口,满足开发者在各种场景下的调用需求。
所有接口支持 HTTP 或者 HTTPS 请求,部分接口采用 GET 方法,部分接口采用 POST 方法;接口返回数据的格式支持文本、json、xml。
具体请参见接口文档。
对于代理提取API,您可以到提取工具在线生成API链接,内置到您的程序中:
其他接口请查看API文档,获取接口url和参数说明,自己生成API链接。
(1)浏览器测试
您可以把生成的API链接直接在浏览器里打开,查看返回结果。例如,您直接点击如下api链接
https://proxy.zzqidc.com/query?Key=0B***607
(2)命令行测试
如果您在linux系统下,可以通过curl命令请求API链接查看结果:
curl "https://proxy.zzqidc.com/allocate?Key=请改成您的Key
公共错误码
错误码 | 描述 |
---|---|
1 | 未知错误 |
10 | 参数不合法! |
100 | 计划不存在或已过期! |
101 | 请求数量超过计划通道数! |
102 | 没有剩余的可用通道! |
103 | 资源不足 |
105 | 释放的IP数超过允许释放的IP数 |
查看API调用的代码样例 >>