海外套餐IP白名单文档

更新时间：2026-07-09

IP 白名单功能是代理 IP 服务中的重要安全配置模块，通过设置受信任的 IP 地址列表，可以有效控制 API 接口的访问权限，保障账户安全。本文档详细介绍海外套餐的 IP 白名单配置方法及 API 接口使用说明。

一、公共部分参考

1.1 请求域名

所有 OpenAPI 接口统一通过以下域名访问：

https://openapi.fanproxy.com

1.2 请求头要求

所有 OpenAPI 接口均通过网关（Gateway）进行签名认证，请求必须携带以下请求头。

必填请求头

请求头名称	类型	必填	说明
X-Api-Key	String	是	用户账号，即手机号
X-Api-Signature	String	是	API 签名凭证，由平台生成，可前往官网控制台查看
X-Api-Timestamp	String	是	请求时间戳（秒），用于防重放攻击

请求头示例

POST /open-api/open/overseas/subaccount/add HTTP/1.1
Host: openapi.fanproxy.com
Content-Type: application/json
X-Api-Key: your_api_key_here
X-Api-Signature: your_signature_here
X-Api-Timestamp: 1711000000

二、API 白名单接口

海外地址：https://openapi.fanproxy.com

功能	方法	路径	Query 参数
添加	GET	/open-api/open/white/abroad/add	ip 必填，多个 IP 英文逗号分隔，如 1.2.3.4,5.6.7.8
删除	GET	/open-api/open/white/abroad/delete	ip 必填
查询	GET	/open-api/open/white/abroad/query	ip 选填；不传则查询该客户全部白名单 IP

三、请求参数

参数名	类型	必填	说明
ip	string	否	IP 地址，多个 IP 用英文逗号分隔；不传则返回该客户所有白名单 IP

四、统一响应结构

所有接口返回统一格式的 JSON 数据结构，便于程序解析和处理：

字段	类型	说明
code	int	返回码，0 表示成功
msg	string	返回消息描述
data	string[]	返回的 IP 列表（部分接口有值）

五、响应示例

5.1 成功响应

{
"code": 200,
"data": [
"117.89.34.11",
"117.89.34.12"
],
"message": null,
"success": true
}

5.2 失败响应

{
"code": 1212,
"data": null,
"message": "white ip not allowed",
"success": false
}

六、错误码

错误码	说明
0	成功
1201	请求参数错误
1202	客户不存在
1203	客户状态未激活
1204	添加白名单失败
1205	删除白名单失败
1206	更新白名单失败
1207	查询白名单失败
1208	IP 已在白名单中
1209	IP 已在全局白名单中
1210	IP 不在白名单中
1211	白名单 IP 数量超出上限
1212	IP 不在允许的地区范围内
1250	校验白名单失败
5000	服务器内部错误
20000006	网络波动
20000007	参数/状态异常
20000005	系统异常

国内套餐IP白名单文档