使用须知：

1.使用前请先完成账号注册，并且保证在海外环境下使用；

2.如果您业务的国家属于亚洲，如附录表国家，建议您在新加坡租用请求源服务器，这样可以达到最低延迟；

3.如果您业务国家属于美国或非亚洲国家，建议您在圣佛兰西斯科租用源服务器，这样可以达到最低延迟。

示例代码：

我们提供了多种编程语言接入示例，您可以前往下载参考：前往下载

目录：

  1.API 说明

  2.登录获取token

  3.ip代理账号管理

   3.1 创建ip代理账号

    3.2 获取ip代理账号列表

    3.3 更新某ip代理账号的参数

    3.4 移除ip代理账号

    3.5 查询ip代理账号流量消耗

  4.使用IP代理

    4.1 以api提取的方式使用

    4.2 以组合代理帐号方式使用

  5.源地址ip白名单管理

    5.1 增加ip到白名单

    5.2 获取白名单ip列表

    5.3 修改白名单ip

    5.4 从白名单移除ip

  6.统计报表

    6.1 流量充值历史记录

    6.2 流量消耗每5分钟统计结果

    6.3 流量消耗每天统计结果

  7.查询国家和地区码

1.API 说明

返回值为如下json格式：

  {
      "code": 0,
      "msg": "success",
      "data": xxxx
  }
      

data对象包含的字段名称	含义
code	应答code
msg	应答提示
data	应答数据对象

应答code	含义
0	成功
400	参数错误
401	token无效或用户名密码错误
423	用户被管理员锁定了
500	服务器端出错

2.登录获取token(http get)

实例: http://api.seaproxy.net:8082/agent/customer_login?cust_code=xxx&password=xxx

请求参数名称	含义	是否必填
cust_code	注册时的邮箱地址	是
password	注册时的密码	是

data对象包含的字段名称	含义
token	token 代表该用户在服务器上的登录凭证，在接下来的 api 请求中，作为参数传入

3.ip代理账号管理（免认证、隧道代理、账密ip都适用）

3.1 创建ip代理账号(http get)

实例: http://api.seaproxy.net:8082/agent/customer_proxyuser/add?token=xxx&&proxy_user=xxx&proxy_pass=xxx&content=1234&status=1&flow_cap=100&flow_islimit=true

请求参数名称	含义	是否必填
token	token	是
proxy_user	填写要创建的ip代理账号。只能包括字母、数字、下划线，最多 15 个字符，不能包括'-'和':'字符	是
proxy_pass	填写要创建的ip代理密码。只能包括字母、数字、下划线，最多 15 个字符，不能包括'-'和':'字符	是
status	账号是否启用，1为启用、0为不启用	否 默认为1
flow_cap	最大可使用流量(MB)	否
flow_islimit	flow_cap是否有效，true为有效、false为无效	否 默认为false
content	备注	否

应答code	含义
409	proxy_user已经存在
412	用户的proxy_user数量已经达到20个了

3.2 获取ip代理账号列表(http get)

实例: http://api.seaproxy.net:8082/agent/customer_proxyuser/fetch?token=xxx&proxy_user=xxx&limit=50&offset=0

请求参数名称	含义	是否必填
token	token	是
proxy_user	要查询的ip代理账号,多个使用英文逗号隔开	否
offset	从第多少个开始取	否 默认为0
limit	最多取多少个	否 默认为100

data对象包含的字段名称	含义
proxy_user	ip代理账号
proxy_pass	ip代理密码
create_time	创建时间(北京)
update_time	更新时间(北京)
used_time	最后使用时间(北京)
usedat	最后使用时间戳(utc秒)
flow_used	已经使用的流量(MB)
已经使用的流量(MB)	容许使用的流量(MB)，flow_islimit为true时有效
flow_islimit	flow_cap是否有效，true为有效、false为无效
status	账号是否启用，1为启用、0为不启用
content	备注

3.3 更新某ip代理账号的参数(http get

实例: http://api.seaproxy.net:8082/agent/customer_proxywhite/update?token=xxx&&proxy_user=xxx&proxy_pass=xxx&content=1235&status=1

请求参数名称	含义	是否必须
token	token	是
proxy_user	ip代理账号	是
proxy_pass	ip代理密码。只能包括字母、数字、下划线，最多 15 个字符，不能包括'-'和':'字符	否
status	账号是否启用，1为启用、0为不启用	否 默认为1
flow_cap	最大可使用流量(MB)	否
flow_islimit	是否限制最大可使用流量，true为使能、false为不使能	否 默认为false
content	备注	否

应答code	含义
404	proxy_user不存在
412	不满足更新条件

3.4 移除ip代理账号(http get)

实例:http://api.seaproxy.net:8082/agent/customer_proxywhite/remove?token=xxx&&proxy_user=xxx

请求参数名称	含义	是否必须
token	token	是
proxy_user	准备移除的ip代理账号,使用英文逗号隔开可移除多个	是

3.5 查询ip代理账号流量消耗(http get)

实例:实例: http://api.seaproxy.net:8082/agent/customer_proxywhite/report5m?token=xxx&&proxy_user=xxx&start_time=2023-03-24 09:30&end_time=2023-03-24 16:30&limit=100&offset=0

请求参数名称	含义	是否必须
token	token	是
proxy_user	ip代理账号	是
start_time	起始时间, 格式为2022-07-06 13:21:50	是
end_time	起始时间, 格式为2022-07-06 13:21:50	是
offset	从第多少条开始取	否 默认为0
limit	最多取多少条	否 默认为100

4.使用代理（所有的请求以及使用须在海外网络环境下）

4.1 以api提取的方式使用（可提取到账密ip和免认证ip）(http get)

实例：http://api.seaproxy.net:8082/client_getip?user=xxx&pass=xxx&protocol=0&count=30&hours=0&portmap=0&keeptime=120®ion=BR

请求参数名称	含义	是否必须
user	就是如上第3点创建的proxy_user(ip代理账号)【注意：不是注册时的邮箱地址】	是
pass	就是如上第3点创建的proxy_pass(ip代理密码)【注意：不是注册时的密码】	是
region	国家代码	否 默认全球
area	相应国家的地区	否 默认全国
count	提取ip的数量	是
protocol	IP协议。1:http/https, 0:socks5	否 默认1
ft	api返回数据格式 1 text 2 json	否 默认2
pat	当format为text格式时的内容分割符 1: \r\n 2: \r 3: \n 4: \t	否 默认1
portmap	该参数为1时，为免认证ip方式（ip＋端口），不同的ip和端口代表不同的出口ip。 该参数为0时，返回user和pass的账密ip（账号、密码、ip、端口）。	否
keeptime	IP时效，单位为分钟，须为正整数。 portmap为1时，这时取到的是免认证ip（ip＋端口），此时keeptime值代表端口失效时间，keeptime默认3分钟（只可以填写3-30分钟内数值），到期后端口回收且网络连接断开； portmap为0时，这时取到的是账密ip，keeptime数值代表自动切换ip时间，到期后自动切换相同出口条件ip，如keeptime数值为0则该ip断开后不会自动切换ip，网络连接断开	否
hours	该参数为1时，提取到的ip更稳定，代表优选ip池。该参数为0时，代表不走优选ip池。	否

data对象包含的字段名称	含义
user	代理验证用户(如果portmap=1，该值为空)
pass	代理验证密码(如果portmap=1，该值为空)
ip	代理请求ip地址
port	代理请求端口
ptype	支持的协议名称,socks5或http

应答code	含义
0	成功
400	参数缺失或无效
401	proxy_user或proxy_pass错误
404	proxy_user不存在
412	用户流量不够
423	proxy_user被锁定了
500	服务器端出错

4.2以组合代理帐号方式（隧道代理）使用(http get)

服务器地址：

按win+R进入cmd，输入nslookup proxy.seaproxy.net获取IP地址表格

如果您想获得更低的延迟，您的业务在亚洲，请用如下方式获取ip地址:按win+R进入cmd，输入nslookup sgpproxy.seaproxy.net获取亚洲IP地址表格。

如果您想获得更低的延迟，您的业务在非亚洲区域，请用如下方式获取ip地址：按win+R进入cmd，输入nslookup usproxy.seaproxy.net获取非亚洲IP地址表格。

端口：9999

密码：该密码为以上第3点创建的proxy_pass(ip代理密码)

账号：组合方式以'-'连接各字段。格式为：

{proxy_user}-{随机数}-region-{国家码}-area-{地区码}-keeptime-{ip保持分钟数}-hours-{取优选ip}

proxy_user:以上第3点创建的proxy_pass(ip代理账号)。

随机数:通过该参数区分不同ip，如果该值为空表示每次都更换ip。

region:用于指定国家(如不填写该参数默认为所有国家)。

area:用于指地区(如不填写该参数默认为所有地区)。

keeptime:单位为分钟，须为正整数。代表自动切换ip时间，值大于0时到期后自动切换相同出口条件ip，为0时则该ip断开后不会自动切换ip，网络连接断。

hours:该参数为1时，提取到的ip更稳定，代表优选ip池。该参数为0时，代表不走优选ip池。

【注意】

1：{proxy_user}-{随机数}为必填项且必须在最前面。

2：国家码为大写字母。

3：服务器地址必须用以上方法获取ip地址，以ip地址为服务器地址，不可直接填写sgpproxy.seaproxy.net或usproxy.seaproxy.net

例如：某用户的proxy_user为hello199, proxy_pass为world。则

hello199-123-region-US-keeptime-30-hours-1

解释：取美国优选ip，30分钟自动切换。

hello199-123-region-US-keeptime-30-hours-0

解释：取美国全部ip池子，30分钟自动切换新ip。

hello199-123-region-US-keeptime-0-hours-0

解释：keeptime为0，表示ip掉线后不会自动切换同条件ip，hours为0,表示取美国全部ip池子里的ip。

hello199--region-US-keeptime-0-hours-0

解释：每次连接都更换ip。

使用http/https协议代理时返回的错误码(http get)

应答code	含义
400	没有host
407	没有auth数据
510	连接目的地址失败
512	出口ip不在线
513	出口ip上的连接超过限制
514	用户没有流量了
515	服务器还没有准备好(用户数据还没同步好)
516	切换ip失败
517	目的地址黑白名单验证不通过
518	auth验证失败

使用socks5协议代理时返回的错误码(http get)

应答code	含义
0xFF	切换ip失败
0x02	auth失败
0x03	出口ip不在线
0x05	连接目的地址失败
0x0A	出口ip上的连接超过限制
0x0B	用户没有流量了
0x0C	服务器还没有准备好(用户数据还没同步好)
0x0D	目的地址黑白名单验证不通过

5.源地址ip白名单管理(针对portmap填1数值时免认证ip代理方式)

5.1增加ip到白名单(http get)

实例: http://api.seaproxy.net:8082/agent/customer_proxywhite/add?token=xxx&ip=xxx

请求参数名称	含义	是否必须
token	token	是
ip	填写需要增加到白名单的ip,如需添加多个ip使用英文逗号隔开，最多可以添加6个	是
备注	切换失败	否

应答code	含义
409	IP已经存在
412	当前用户的白名单ip数已经达到6个了

5.2 获取白名单ip列表(http get)

实例: http://api.seaproxy.net:8082/agent/customer_proxywhite/fetch?token=xxx

请求参数名称	含义	是否必须
token	token	是
ip	填写需要查询的ip,如需查询多个ip使用英文逗号隔开	否

data对象包含的字段名称	含义
ip	IP地址
status	使能状态，1为使能、0为不使能
create_time	创建时间(北京时间)
创建时间(北京时间)	备注

5.3 修改白名单ip的参数(http get)

实例: http://api.seaproxy.net:8082/agent/customer_proxywhite/update?token=xxx&ip=xxx&status=0&content=iptest

请求参数名称	含义	是否必须
token	token	是
ip	填写需要修改的ip,如需修改多个ip使用英文逗号隔开	否
content	备注	否
status	是否启用，0是不启用，1是启用	否

5.4 从白名单移除ip(http get)

实例: http://api.seaproxy.net:8082/agent/customer_proxywhite/remove?token=xxx&ip=xxx

请求参数名称	含义	是否必须
token	token	是
ip	填写需要修改的ip,如需修改多个ip使用英文逗号隔开	否

6.统计报表

6.1 流量充值历史记录(http get)

实例: http://api.seaproxy.net:8082/agent/customer_charge_humanreport?token=xxxxx&start_day=2022-06-17 18:10:54&end_day=2022-06-17 18:18:55

请求参数名称	含义	是否必须
token	token	是
start_day	起始时间, 格式为2022-07-06 13:21:50	是
end_day	结束时间, 格式为2022-07-06 13:21:50	是
limit	取多少条记录	否 默认为1000
token	从第几条开始取	否 默认为0

data对象包含的字段名称	含义
user_remain	剩余流量(MB)
sum	在查询时间区间内总共充了多少流量
data_count	时间以及对应的流量值(MB)

6.2 流量消耗每5分钟统计结果(http get)

实例: http://api.seaproxy.net:8082/agent/customer_5min_humanreport?token=xxx&start_day=2022-03-17 18:10:54&end_day=2022-06-20

请求参数名称	含义	是否必须
token	token	是
start_day	起始时间, 格式为2022-07-06 13:21:50	是
end_day	结束时间, 格式为2022-07-06 13:21:50	是
limit	取多少条记录	否 默认为1000
token	从第几条开始取	否 默认为0

data对象包含的字段名称	含义
user_remain	剩余流量(MB)
sum	在查询时间区间内总共充了多少流量
data_count	时间以及对应的流量值(MB)

5.3 流量消耗每天统计结果(http get)

实例: http://api.seaproxy.net:8082/agent/customer_day_humanreport?token=xxxxx&start_day=2022-03-17&end_day=2022-06-20

请求参数名称	含义	是否必须
token	token	是
start_day	起始时间, 格式为2022-07-06 13:21:50	是
end_day	结束时间, 格式为2022-07-06 13:21:50	是
limit	取多少条记录	否 默认为1000
token	从第几条开始取	否 默认为0

data对象包含的字段名称	含义
user_remain	剩余流量(MB)
sum	在查询时间区间内总共充了多少流量
data_count	时间以及对应的流量值(MB)

7.查询国家和地区码

7.1 国家码列表(http get)

实例: http://api.seaproxy.net:8082/agent/customer_regions

data对象包含的字段名称	含义
data_count	国家码列表

7.2 国家码列表(http get)

实例: http://api.seaproxy.net:8082/agent/customer_rgareaids?region=US

请求参数名称	含义	含义
region	国家码	是

data对象包含的字段名称	含义
data_count	地区名称以及所对应的id号

8.国家/地区代码

亚洲（新加坡服务器集群）：

AZ: 阿塞拜疆, IN: 印度, IL: 以色列, VN: 越南, IQ: 伊拉克, GE: 格鲁吉亚, KR: 韩国, AE: 阿联酋, BN: 文莱, ID: 印度尼西亚, IR: 伊朗, TJ: 塔吉克斯坦, TH: 泰国, MO: 中国澳门, CN: 中国, OM: 阿曼, TW: 中国台湾, NP: 尼泊尔, MY: 马来西亚, YE: 也门, KG: 吉尔吉斯斯坦, JO: 约旦, QA: 卡塔尔, SA: 沙特阿拉伯, KZ: 哈萨克斯坦, LB: 黎巴嫩, LK: 斯里兰卡, BH: 巴林, PK: 巴基斯坦, KW: 科威特, PH: 菲律宾, MN: 蒙古, LA: 老挝, UZ: 乌兹别克斯坦, JP: 日本, KH: 柬埔寨, PS: 巴勒斯坦, AM: 亚美尼亚, BD: 孟加拉, HK: 中国香港, MV: 马尔代夫, SG: 新加坡, CY: 塞浦路斯, TL: 东帝汶, MM: 缅甸, BT: 不丹, AF: 阿富汗, SY: 叙利亚

欧洲（美国服务器集群）：

BG: 保加利亚, XK: 科索沃, AT: 奥地利, RO: 罗马尼亚, BY: 白俄罗斯, MT: 马耳他, RS: 塞尔维亚, CH: 瑞士, BE: 比利时, LT: 立陶宛, GR: 希腊, BA: 波斯尼亚和黑塞哥维那, RU: 俄罗斯, SI: 斯洛文尼亚, NL: 荷兰, SE: 瑞典, ME: 黑山, LV: 拉脱维亚, DE: 德国, GB: 英国, MK: 北马其顿, TR: 土耳其, HU: 匈牙利, IE: 爱尔兰, AD: 安道尔, PT: 葡萄牙,UA: 乌克兰, CZ: 捷克, IT: 意大利, FR: 法国, HR: 克罗地亚, IM: 马恩岛, FI: 芬兰, PL: 波兰, DK: 丹麦, ES: 西班牙, MD: 摩尔多瓦, LI: 列支敦士登, AL: 阿尔巴尼亚, SK: 斯洛伐克, JE: 泽西岛, SX: 荷属圣马丁, GI: 直布罗陀, EE: 爱沙尼亚, GG: 根西岛, NO: 挪威, LU: 卢森堡, MC: 摩纳哥, FO: 法罗群岛, AX: 奥兰群岛, SM: 圣马力诺, IS: 冰岛

美洲（美国服务器集群）：

BR: 巴西, AR: 阿根廷, VE: 委内瑞拉, BO: 玻利维亚, CL: 智利, CA: 加拿大, DO: 多米尼加, LC: 圣卢西亚, CW: 库拉索, PY: 巴拉圭,GP: 瓜德罗普, MF: 法属圣马丁, PE: 秘鲁, HN: 洪都拉斯, CO: 哥伦比亚, MQ: 马提尼克, GY: 圭亚那, UY: 乌拉圭, VI: 美属维尔京群岛, TT:特立尼达和多巴哥, PR:波多黎各, PA: 巴拿马, US: 美国, SR: 苏里南, GT: 危地马拉, MX: 墨西哥, DM: 多米尼克, SV: 萨尔瓦多, NI: 尼加拉瓜, KN: 圣基茨和尼维斯, BS: 巴哈马, CR: 哥斯达黎加, BB: 巴巴多斯, GL: 格陵兰, BZ: 伯利兹, AW: 阿鲁巴, FK: 福克兰群岛, GF: 法属圭亚那, BM: 百慕大, GD: 格林纳达, VG: 英属维尔京群岛, HT: 海地, KY: 开曼群岛, AI: 安圭拉, VC: 圣文森特和格林纳丁斯, CU: 古巴, AG: 安提瓜和巴布达, TC: 特克斯和凯科斯群岛

非洲（美国服务器集群）：

SN: 塞内加尔, CI: 科特迪瓦, TN: 突尼斯, TZ: 坦桑尼亚, MU: 毛里求斯, AO: 安哥拉, EG: 埃及, DZ: 阿尔及利亚, EC: 厄瓜多尔, MA: 摩洛哥, RE: 留尼汪岛, SD: 苏丹, CM: 喀麦隆, NG: 尼日利亚, JM: 牙买加, KE: 肯尼亚, GA: 加蓬, SC: 塞舌尔, CV: 佛得角, ZA: 南非, YT: 马约特, SL: 塞拉利昂, BW: 博茨瓦纳, MW: 马拉维, TG: 多哥, SZ: 斯威士兰, ET: 埃塞俄比亚, MR: 毛里塔尼亚, GM: 冈比亚, MZ: 莫桑比克, GQ: 赤道几内亚, KM: 科摩罗, BI: 布隆迪, CG: 刚果共和国, GN: 几内亚, RW: 卢旺达, SS: 南苏丹, CD: 刚果民主共和国, ML: 马里, SO: 索马里, LR: 利比里亚, NA: 纳米比亚, GH: 加纳, MG: 马达加斯加, LY: 利比亚, BJ: 贝宁, UG: 乌干达, BF: 布基纳法索, NE: 尼日尔, ZW: 津巴布韦, LS: 莱索托, ZM: 赞比亚, ST: 圣多美和普林西比

大洋洲（美国服务器集群）：

WS: 萨摩亚, AU: 澳大利亚, GU: 关岛, NZ: 新西兰, NC: 新喀里多尼亚, FJ: 斐济, WF: 瓦利斯和富图纳群岛, MP: 北马里亚纳群岛, PW: 帕劳, TO: 汤加, SB: 所罗门群岛, AS: 美属萨摩亚, MH: 马绍尔群岛, VU: 瓦努阿图, PF: 法属波利尼西亚, CK: 库克群岛, MS: 蒙特塞拉特岛, BQ: 荷兰加勒比