1.请求结构:
服务地址:目前支持的域名列表为:
接口域名 | 域名 |
---|---|
请求域名 | proxy.yunkv.com |
2.公共参数
公共参数是用于标识用户和接口的参数,如非必要,在每个接口单独的接口文档中不再对这些参数进行说明,但每次请求均需要携带这些参数,才能正常发起请求。
参数名 | 是否必选 | 类型 | 描述 |
---|---|---|---|
Method | 是 | String | 具体操作的指令接口名称,例如想要调用查询代理IP列表接口,则Method参数即为query。 |
Key | 是 | String | 在 https://host.jinyaoyunwei.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.yunkv.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编码。