海外动态代理开发手册

总览

新手开发者可通过如下2个步骤使用海外动态代理：

一、购买成功后，先在会员中心查看海外信息，进行本地调试和验证。

二、海外动态代理代码使用方式和隧道代理一致，请参考隧道代码样例请求海外动态代理访问目标网站。

ip地区、换ip周期设置

管理台设置

您可以在会员中心-海外动态代理订单管理里查看和修改当前的地区、周期配置，修改成功后一分钟内生效。

编码设置

以使用美国-纽约地区ip、换ip周期1分钟为例。
您可以在程序中通过如下两种方式设置：

方式一：通过用户名密码设置地区、周期

以这样的格式{username}-region-{US}-area-{New York}-period-{1}:{password}，将用户名、国家编码、地区编码、换ip周期(分钟)、密码填入后base64编码生成Proxy-Authorization。
例如用户名为f2964279696，密码为jkr369ry，本次请求使用美国-纽约地区ip、换ip周期1分钟。以Python为例，用如下代码段生成base64验证串：

import base64
print base64.b64encode('f2964279696-region-US-area-New York-period-1:jkr369ry')

另外您也可以配置多个用户名密码，指定不同的地区、周期，根据业务不同灵活使用。
base64.b64encode('f2964279696-region-JP-area-Tokyo-period-0:jkr369ry') # 日本东京地区、每次请求换ip
base64.b64encode('f2964279696-region-GB-period-1:jkr369ry') # 英国地区、1分钟换ip

方式二：通过Header设置地区、周期（只支持http）

以本次请求使用美国-纽约地区ip、换ip周期1分钟为例，在发起http请求时携带如下Header（Header不区分大小写）：

Kdl-Region: US    
Kdl-Area: New York
Kdl-Period: 1

同样的您也可以配置多个header，指定不同的地区、周期，根据业务不同灵活使用。（使用提示：方式一的优先级高于方式二）

国家编码、地区名称可以通过快代理提供的api获取，GetFpsCountryCode 获取国家编码、GetFpsAreaCode 获取地区编码。

当您通过编码方式设置地区、周期，系统会忽略您在会员中心-海外动态代理订单管理里的地区、周期配置。
如果您目标网站所在的国家属于亚洲，建议您在新加坡(或附近)租用请求源服务器，并且使用亚洲代理域名as.xxx.kdlfps.com，这样可以达到最低延迟；如果您目标网站所在的国家属于美国或者非亚洲国家，建议您在圣佛兰西斯科(或附近)租用请求源服务器，并且使用美洲代理域名us.xxx.kdlfps.com,这样可以达到最低延迟

周期版使用多通道

对于需要周期性换IP的海外动态代理，支持多通道使用，在同一换IP周期内每个通道会转发一个独立的代理IP。

只支持通过用户名设置通道

以本次请求使用美国-纽约地区ip、换ip周期1分钟为例，设置参数sid，每个sid对应一个通道，sid为长度不超过6位的随机字符串。

f2964279696-region-US-area-New York-period-1-sid-ss01:jkr369ry  # 通道一
f2964279696-region-US-area-New York-period-1-sid-ss02:jkr369ry  # 通道二
f2964279696-region-US-area-New York-period-1-sid-ss03:jkr369ry  # 通道三
...

API接口

海外动态代理API接口一览

接口名称	接口功能
GetFps	获取海外动态代理IP
Getfpsflow	获取海外动态代理使用流量
GetFpsCountryCode	获取海外动态代理国家编码
GetFpsAreaCode	获取海外地区（省/州）编码
GetIpWhitelist	获取IP白名单
SetIpWhitelist	设置IP白名单
AddWhiteIP	添加白名单IP
DelWhiteIP	删除白名单IP
GetProxyAuthorization	获取鉴权信息

测试海外动态代理可用性

海外动态代理支持白名单和用户名密码两种验证方式，建议您先在本机测试，测试OK后就可以正常使用了。

查看测试步骤

关于IP白名单数量

如果您选择设置白名单访问海外，最多可设置200个白名单IP。
只要请求不超过购买时选择的每秒并发数，通过用户名密码访问海外的IP数量没有限制。

错误码一览

HTTP返回码	Response body 内容	说明
407	情况一：Proxy Authentication Failed:%auth 情况二：White IP Failed:$client_ip	情况一：用户名密码验证失败情况二：白名单验证失败
440	Bandwidth Over Limit	带宽超限
441	Request Rate Over Limit	HTTP请求/TCP连接超频
442	Authentication Type Error	认证方式检测失败
446	Host DNS Failed	DNS解析错误
447	Real-name Authentication Required	需要实名认证
451	Miss Host	代理请求格式不正确
452	Public Host Required	目标地址不是公网IP
453	Proxy Port Error	使用了错误的端口号
456	CN Client Forbidden	中国大陆客户端禁止
459	Insufficient Traffic	剩余流量不足
503	Proxy Connect Error	连接目标网站失败

海外动态代理使用统计

隧道模式统计功能提供了对请求量和请求错误的统计分析。
您可以随时关注采集程序的运行走势，了解发生的错误并及时修正。我们还为几种常见的错误提供了分析和提示，帮助您提升采集程序运行的成功率。

IP使用统计
状态统计

流量统计方便您跟踪流量的使用详情。通过流量统计折线图，您可以更好地把控带宽使用情况。

隧道模式统计

开发建议

参考如下开发建议，可以帮助您更加顺利地完成开发和调试：

控制好请求频率，用同一IP请求同一网站建议不超过1秒1次，避免IP被目标网站屏蔽。
建议关闭HTTP协议的keep-alive功能，避免因连接复用导致海外不能切换IP
尽可能采用gzip压缩加速访问，在header里添加：Accept-Encoding: gzip
关注海外代理动态住宅返回码可协助您排查错误。

使用gzip详解

使用gzip压缩传输数据可显著提升访问速度，方法非常简单：
只需在http请求的header里加上：
Accept-Encoding: gzip
收到HTTP Response后检查header里是否包含：
Content-Encoding: gzip
如果包含，则对body进行gzip解压，就能得到原始内容。

代码样例

海外动态代理代码使用方式和隧道代理一致，请参考隧道代码样例

SDK下载