同时勾选HTTP和HTTPS设置,填入代理服务器IP地址和端口号。如果是私密代理或独享代理,勾选代理服务器要求密码,填入用户名密码;
填入代理服务器IP地址和端口号,如果是私密代理或独享代理,勾选代理服务器要求密码,填入用户名密码。
浏览器打开https://m.baidu.com/s?word=ip, 搜索IP,结果里出现的IP地址和设置的代理IP一致,说明代理设置成功。
使用提示:
代理设置完成后系统常用软件,如浏览器、QQ等都会走代理,但终端(Terminal)并不会走代理,要让终端走代理,请看下面的设置。
打开终端,通过如下命令设置Http代理:
```
proxy_ip='59.38.241.25' proxy_port='23918' username='myusername' password='mypassword' #设置http代理 export http_proxy=http://$username:$password@$proxy_ip:$proxy_port #设置https代理 export https_proxy=http://$username:$password@$proxy_ip:$proxy_port
```
确认代理设置成功:
#返回的IP和设置的代理IP一致则表示代理设置成功 curl cip.cc。
接口地址: https://www.fwvps.com/resources
本接口用于查询平台可用的代理IP资源列表。
该接口单个Key的请求频率限制为:60 次/分钟;
方法:HTTP、GET,需要注意不能混合使用;
编码:参数和返回内容均采用utf-8编码。
参数名 | 是否必选 | 类型 | 描述 |
---|---|---|---|
Key | 是 | String | 查询的Key值 |
AreaId | 否 | String | 区域编号 |
Isp | 否 | Integer | 运营商编号 |
Status | 否 | Integer | 可用状态 0:不可用,1:可用 |
接口可返回文本格式、json格式、xml格式,字段说明如下:
参数名 | 类型 | 描述 |
---|---|---|
Code | Integer | 结果编码:0(成功)-1(失败) |
Data | Array | 资源列表 |
请求接口示例:
返回示例:
{
"Code ":0,
"Data ": [
{
"AreaId ": "320382 ",
"AreaName ": "福建泉州市",
"Isp": "1",
"IspName ": "电信",
"Status ": "1",
}
]
}
错误码 | 描述 |
---|---|
-1 | 未知错误 |
-2 | 数据库操作异常 |
-10 | 参数不合法 |
-11 | 请求过于频繁 |
-100 | 计划不存在或已过期 |
接口地址: https://www.fwvps.com/info/quota
本接口用于查询IP提取余量。
该接口单个Key的请求频率限制为:60次/分钟;
方法:HTTP、GET,需要注意不能混合使用;
编码:参数和返回内容均采用utf-8编码。
参数名 | 是否必选 | 类型 | 描述 |
---|---|---|---|
Key | 是 | String | 查询的Key值 |
接口可返回文本格式、json格式、xml格式,字段说明如下:
参数名 | 类型 | 描述 |
---|---|---|
Code | Integer | 结果编码:0(成功)-1(失败) |
Total | Integer | 总数量 |
Available | Integer | 可用数量 |
Used | Array | 已使用数量 |
请求接口示例:
返回示例:
{
"Code ":0,
"Total ":5,
"Available ":3,
"Used":2
}
错误码 | 描述 |
---|---|
-1 | 未知错误 |
-10 | 参数不合法 |
-11 | 请求过于频繁 |
-100 | 计划不存在或已过期 |
接口地址: https://www.fwvps.com/whitelist/query
本接口用于查询IP的白名单。
该接口单个Key的请求频率限制为:60次/分钟;
方法:HTTP、GET,需要注意不能混合使用;
编码:参数和返回内容均采用utf-8编码。
参数名 | 是否必选 | 类型 | 描述 |
---|---|---|---|
Key | 是 | String | 查询白名单的Key值 |
TaskID | 是 | Integer | 任务编号ID |
detail | 是 | Integer | 详情0(关闭) 1(开启) |
接口可返回文本格式、json格式、xml格式,字段说明如下:
参数名 | 类型 | 描述 |
---|---|---|
Code | Integer | 结果编码:0(成功)-1(失败) |
Num | Integer | 数量 |
Data | Array | IP白名单列表 |
请求接口示例:
https://www.fwvps.com/whitelist/query ?Key=请改成您的Key
返回示例:
{
"Code ":0,
"Num",1
Data:[
"192.168.1.1",
"192.168.1.2"
]
}
错误码 | 描述 |
---|---|
1 | 未知错误 |
10 | 参数不合法! |
100 | 计划不存在或已过期! |
101 | 请求数量超过计划通道数! |
102 | 没有剩余的可用通道! |
1.接口描述:
本接口用于删除IP的白名单。接口请求地址https://www.fwvps.com/whitelist/del
注:该接口单个Key的请求频率限制为:20 次/分钟
2.输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名 | 是否必选 | 类型 | 描述 |
---|---|---|---|
Key | 是 | String | 删除白名单的Key值 |
IP | 是 | Integer | 白名单IP,多个以逗号”, “分隔 |
3.输出参数
参数名 | 类型 | 描述 |
---|---|---|
Code | Integer | 结果编码:0(成功)-1(失败) |
4.错误码
公共错误码:
-1 未知错误
-10 参数不合法!
-100 计划不存在或已过期!
-101 请求数量超过计划通道数!
-102 没有剩余的可用通道。
5.请求示例
请求参数:
https://www.fwvps.com/whitelist/del?<公共请求参数>
返回参数,JSON格式,详情如下:
{
"Code ":0
}
接口地址:https://www.fwvps.com/whitelist/add
本接口用于添加IP的白名单。
该接口单个Key的请求频率限制为:20次/分钟;
方法:HTTP、GET,需要注意不能混合使用;
编码:参数和返回内容均采用utf-8编码。
参数名 | 是否必选 | 类型 | 描述 |
---|---|---|---|
Key | 是 | String | 添加白名单的Key值。 |
IP | 是 | Integer | 白名单IP,多个以逗号”, “分隔。 |
接口可返回文本格式、json格式、xml格式,字段说明如下:
参数名 | 类型 | 描述 |
---|---|---|
Code | Integer | 结果编码:0(成功)-1(失败) |
请求接口示例:
返回示例:
{
"Code ":0
}
错误码 | 描述 |
---|---|
-202 | 白名单数量超过限制 |
接口地址:https://www.fwvps.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 | 申请数量,默认为1 |
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://www.fwvps.com/query
本接口用于查询用户可用的代理IP资源列表。
该接口单个Key的请求频率限制为:(通道数*5+10)次/分钟;
方法:HTTP、GET,需要注意不能混合使用;
编码:参数和返回内容均采用utf-8编码。
参数名 | 是否必选 | 类型 | 描述 |
---|---|---|---|
Key | 是 | String | 查询的Key值 |
TaskID | 否 | String | 任务ID;多个以逗号分割;默认全部 |
Detail | 否 | Integer | 详情0(关闭) 1(开启),默认为0 |
接口可返回json格式,字段说明如下:
参数名 | 类型 | 描述 |
---|---|---|
Code | Integer | 结果编码:0(成功)-1(失败) |
TotalNum | Integer | 总IP数 |
TaskNum | Integer | 任务数 |
TaskList | Array | 任务列表 |
请求接口示例:
https://www.fwvps.com/query?Key=请改成您的Key
返回示例:
{
"Code ":0,
"TotalNum":5,
"TaskNum":5,
"TaskList ": [
{
"IP ": "127.0.0.1",
"port ": "49168",
"deadline ": "2018-05-11 02:56:02",
"host ": "127.0.0.1:49168",
}
]
}
错误码 | 描述 |
---|---|
-1 | 未知错误 |
-10 | 参数不合法 |
-11 | 请求过于频繁 |
-100 | 计划不存在或已过期 |
-101 | 请求数量超过计划通道数 |
-102 | 没有剩余的可用通道 |
接口地址:https://www.fwvps.com/query
本接口用于查询用户可用的代理IP资源列表。
该接口单个Key的请求频率限制为:(通道数*5+10)次/分钟;
方法:HTTP、GET,需要注意不能混合使用;
编码:参数和返回内容均采用utf-8编码。
参数名 | 是否必选 | 类型 | 描述 |
---|---|---|---|
Key | 是 | String | 查询的Key值 |
TaskID | 否 | String | 任务ID;多个以逗号分割;默认全部 |
Detail | 否 | Integer | 详情0(关闭) 1(开启),默认为0 |
接口可返回json格式,字段说明如下:
参数名 | 类型 | 描述 |
---|---|---|
Code | Integer | 结果编码:0(成功)-1(失败) |
TotalNum | Integer | 总IP数 |
TaskNum | Integer | 任务数 |
TaskList | Array | 任务列表 |
请求接口示例:
返回示例:
{
"Code ":0,
"TotalNum":5,
"TaskNum":5,
"TaskList ": [
{
"IP ": "127.0.0.1",
"port ": "49168",
"deadline ": "2018-05-11 02:56:02",
"host ": "127.0.0.1:49168",
}
]
}
错误码 | 描述 |
---|---|
-1 | 未知错误 |
-10 | 参数不合法 |
-11 | 请求过于频繁 |
-100 | 计划不存在或已过期 |
-101 | 请求数量超过计划通道数 |
-102 | 没有剩余的可用通道 |
1.请求结构:
服务地址:目前支持的域名列表为:
接口域名 | 域名 |
---|---|
请求域名 | www.fwvps.com |
2.公共参数
公共参数是用于标识用户和接口的参数,如非必要,在每个接口单独的接口文档中不再对这些参数进行说明,但每次请求均需要携带这些参数,才能正常发起请求。
参数名 | 是否必选 | 类型 | 描述 |
---|---|---|---|
Method | 是 | String | 具体操作的指令接口名称,例如想要调用查询代理IP列表接口,则Method参数即为query。 |
Key | 是 | String | 在 https://www.fwvps.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://www.fwvps.comquery?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编码。