API 接口概览

1. 接口简介

快代理提供了功能丰富的API接口，满足开发者在各种场景下的调用需求。
目前已在5种语言的SDK中集成了API调用（查看），欢迎使用。

2. 接口说明

2.1 通信协议

快代理API的所有接口均通过 HTTPS 进行通信，保证通信的高安全性。

2.2 请求方法

同时支持HTTP GET / POST，推荐使用POST请求。
POST 请求支持的 Content-Type: application/x-www-form-urlencoded

2.3 字符编码

均采用UTF-8编码

3. API 列表

接口类别	接口名称
密钥令牌相关接口	• 获得密钥令牌 (get_secret_token) • 检测密钥令牌 (check_secret_token)
账号相关接口	• 获取账户余额 (getaccountbalance) • 获取账户订单列表 (getaccountorders) • 获取订单密钥 (getordersecret)
订单相关接口	• 创建订单 (createorder) • 续费订单 (reneworder) • 获取订单信息 (getorderinfo) • 获取订单到期时间 (getorderexpiretime) • 开启或关闭自动续费 (setautorenew) • 关闭订单 (closeorder)
隧道代理Pro相关接口	• 查询隧道当前IP (tpscurrentip) • 获取隧道代理IP (gettpspro) • 获取隧道代理IP白名单 (getipwhitelist) • 设置隧道代理IP白名单 (setipwhitelist) • 添加白名单IP (addwhiteip) • 删除白名单IP (delwhiteip) • 获取隧道代理鉴权信息 (getproxyauthorization) • 获取隧道代理Pro省份编码 (gettpsprovcode) • 获取隧道代理Pro城市编码 (gettpscitycode)
隧道代理相关接口	• 查询隧道当前IP (tpscurrentip) • 立即更换隧道IP (changetpsip) • 获取隧道代理IP (gettps) • 获取隧道代理IP白名单 (getipwhitelist) • 设置隧道代理IP白名单 (setipwhitelist) • 添加白名单IP (addwhiteip) • 删除白名单IP (delwhiteip) • 获取隧道代理鉴权信息 (getproxyauthorization)
私密代理相关接口	• 获取代理IP (getdps) • 检测私密代理有效性 (checkdpsvalid) • 获取私密代理的可用时长 (getdpsvalidtime) • 获取订单IP提取余额 (getipbalance) • 获取私密代理IP白名单 (getipwhitelist) • 设置私密代理IP白名单 (setipwhitelist) • 添加白名单IP (addwhiteip) • 删除白名单IP (delwhiteip) • 获取私密代理鉴权信息 (getproxyauthorization)
独享代理相关接口	• 获取独享代理IP (getkps) • 查询独享代理城市信息 (querykpscity) • 获取独享代理IP白名单 (getipwhitelist) • 获取订单下指定独享代理IP (getkpsbyid) • 查询独享代理城市信息 (querykpscity) • 纯生版动态型指定地区 (lrpsspecifyregion) • 设置独享代理IP白名单 (setipwhitelist) • 添加白名单IP (addwhiteip) • 删除白名单IP (delwhiteip) • 获取独享代理鉴权信息 (getproxyauthorization)
海外代理动态住宅相关接口	• 获取海外代理IP (getfps) • 获取海外动态代理IP (getfpsip) • 获取海外代理使用流量 (getfpsflow) • 获取海外代理国家编码 (getfpscountrycode) • 获取海外代理地区编码 (getfpsareacode) • 获取海外代理IP白名单 (getipwhitelist) • 设置海外代理IP白名单 (setipwhitelist) • 添加白名单IP (addwhiteip) • 删除白名单IP (delwhiteip) • 获取海外代理鉴权信息 (getproxyauthorization)
海外代理静态住宅相关接口	• 获取海外代理静态住宅IP (getsfps) • 获取海外代理静态住宅IP白名单 (getipwhitelist) • 设置海外代理静态住宅IP白名单 (setipwhitelist) • 添加白名单IP (addwhiteip) • 删除白名单IP (delwhiteip) • 获取海外代理静态住宅鉴权信息 (getproxyauthorization)
工具接口	• 获取指定地区编码 (getareacode) • 获取UA (getua) • 获取本机IP (getmyip)

4. 快速入门

4.1 生成API链接

以获取私密代理IP接口为例，一个典型的API链接如下：

https://dps.kdlapi.com/api/getdps/?
secret_id=o1fjh1re9o28876h7c08&signature=oxf0n0g59h7wcdyvz2uo68ph2s&num=100&pt=1&sep=1

API链接各部分详解

各部分	名称	详解
https	请求使用的协议	调用快代理API接口时，需要使用HTTPS协议
dps.kdlapi.com	API域名
getdps	API接口名称	查看所有API接口
secret_id=o1fjh1re9o28876h7c08	API密钥信息	属于公共参数，所有接口必须携带此参数，订单相关的接口使用对应的订单SecretId，订单号无关的接口(如账号相关接口和工具接口)使用账户SecretId，查看API密钥信息
signature=oxf0n0g59h7wcdyvz2uo68ph2s	签名参数	属于公共参数，其接口必须携带签名参数，以保障接口调用的安全性
num=100	接口相关参数	每个接口有自己特定的参数，具体请参见各接口文档

对于3个代理提取API，您可以在线生成API链接，内置到您的程序中：

其他接口请查看API文档，获取接口url和参数说明，自己生成API链接。

4.2 测试API链接

浏览器测试

您可以把生成的API链接直接在浏览器里打开，查看返回结果。例如，您直接点击如下api链接

https://dps.kdlapi.com/api/getdps/?secret_id=o1fjh1re9o28876h7c08&signature=oxf0n0g59h7wcdyvz2uo68ph2s&num=100&pt=1&sep=1

命令行测试

如果您在linux系统下，可以通过curl命令请求API链接查看结果：

curl "https://dps.kdlapi.com/api/getdps/?secret_id=o1fjh1re9o28876h7c08&signature=oxf0n0g59h7wcdyvz2uo68ph2s&num=100&pt=1&sep=1"

如何测试POST接口

您可以通过curl -d发起POST请求：

curl -d "param1=value1&param2=value2" "https://dev.kdlapi.com/api/apiname"

4.3 错误码

查看公共错误码

每个接口自己的错误码请参见各接口文档。

4.4 代码样例

查看API调用的代码样例

4.5 SDK下载

我们针对5种语言提供了api-sdk，您可以通过sdk简单快速地调用API。

其他语言后续也会陆续支持，敬请期待。

4.6 API调用统计

我们在会员中心提供了统计图，方便您查看实时API调用数据。查看API调用统计

API调用统计图

4.7 API设置与授权

API设置

快代理为对安全性有高要求的用户提供了API调用验证设置，用户可在会员中心-API接口-API设置中根据实际情况进行设置。

1. 密钥明文验证：默认开启，但安全风险高，对安全性有要求的客户可手动关闭。

2. 密钥令牌验证：默认长期开启，仅针对使用密钥令牌验证方式。有效期最短10分钟，最长24小时，可根据自身需求进行设置。

3. API调用授权：开启后，不在白名单中的IP将无法调用所有接口。

安全提示

密钥明文验证安全性极低，密钥泄露风险极高。非特殊场景建议关闭，开启后因密钥泄露导致订单资产损失快代理不承担责任。

API设置

重要提示

企业账号开启“密钥明文验证”、“API调用授权”后，其对应的子账号在调用API时也会受到影响。

API授权

企业账号可以在会员中心-账户管理-子账号管理中为子账号授权可调用的API接口。

子账号API授权