API 接口概览
1. 接口简介
快代理提供了功能丰富的API接口,满足开发者在各种场景下的调用需求。
所有接口支持 HTTP 或 HTTPS 请求,部分接口只支持 GET 方法,部分接口同时支持 GET / POST 方法,具体请参见接口文档。
我们在5种语言的SDK中集成了API调用(查看)。
2. API 列表
3. 快速入门
3.1 生成API链接
以获取开放代理IP接口为例,一个典型的API链接如下:
https://dev.kdlapi.com/api/getproxy?
orderid=965102959536478&signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c&num=100
API链接各部分详解
各部分 | 名称 | 详解 |
---|---|---|
https | 请求使用的协议 | 快代理API接口同时支持http和https 推荐您使用https调用API,请求和返回的内容不容易被监听和泄露 |
dev.kdlapi.com | API域名 | |
getproxy | API接口名称 | 查看所有API接口 |
orderid=965102959536478 | 订单号参数 | 属于公共参数,所有接口必须携带订单号参数,订单号相关的接口使用对应的订单号,订单号无关的接口(如账号相关接口和工具接口)使用虚拟订单号 |
signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c | 签名参数 | 属于公共参数,除4个提取IP的接口外,其余接口必须携带签名参数,以保障接口调用的安全性 getproxy/getdps/getkps/gettps四个接口提供了是否强制携带签名参数的开关(默认关闭,建议业务场景允许的用户自己开启) |
num=100 | 接口相关参数 | 每个接口有自己特定的参数,具体请参见各接口文档 |
签名参数小贴士
快代理提供了2种签名验证方式(详情参见API授权与验证):
- 密钥明文验证 - 使用简单,安全性较低
- 数字签名验证 - 使用略复杂,安全性高
上述API链接示例采用的是密钥明文验证,我们强烈建议您在生产环境使用数字签名验证。
我们在SDK中已为您封装了生成签名参数的逻辑,调用变得非常简单,您只需要关注接口相关参数就好啦。
对于4个代理提取API,您可以在线生成API链接,内置到您的程序中:
其他接口请查看API文档,获取接口url和参数说明,自己生成API链接。
3.2 测试API链接
浏览器测试
您可以把生成的API链接直接在浏览器里打开,查看返回结果。例如,您直接点击如下api链接
命令行测试
如果您在linux系统下,可以通过curl
命令请求API链接查看结果:
curl "http://dev.kdlapi.com/api/getproxy/?orderid=965102959536478&num=100&protocol=1&method=2&an_ha=1&sep=1"
如何测试POST接口
您可以通过curl -d
发起POST请求:
curl -d "param1=value1¶m2=value2" "http://dev.kdlapi.com/api/apiname"
3.3 错误码
每个接口自己的错误码请参见各接口文档。
3.4 代码样例
查看API调用的代码样例
3.5 SDK下载
我们针对5种语言提供了api-sdk,您可以通过sdk简单快速地调用API。
其他语言后续也会陆续支持,敬请期待。
3.6 API调用统计
我们在会员中心提供了统计图,方便您查看实时API调用数据。查看API调用统计