获取指定独享代理IP
1. 接口描述
https://kps.kdlapi.com/api/getkpsbyid 英文代号:get kps by id
实时获取订单下指定独享代理IP。
- 必须使用订单API密钥调用本接口
- 接口最快调用频率: 1秒10次
提示
所有独享代理IP都是极速(响应时间<1秒)、高匿名、支持HTTP GET/POST/CONNECT方法、支持https、支持Socks5
2. 参数说明
| 参数 | 是否必填 | 参数说明 | 取值说明 |
|---|---|---|---|
| secret_id | 是 | 订单SecretId | 查看订单API密钥信息 |
| sign_type | 否 | 签名验证方式。目前支持token和hmacsha1。 | 默认值:token |
| signature | 是 | 请求签名,用来验证此次请求的合法性。 此接口默认需要验证签名 |
支持2种签名验证方式,签名计算方法参见API 授权与验证 |
| timestamp | 否 | 当前 UNIX 时间戳(秒级),可记录发起 API 请求的时间。 sign_type=hmacsha1时此参数有效且为必填项。 |
例如1557546010,如果与当前时间相差过大,会引起签名过期错误。 |
| nonce | 否 | 随机正整数,与 timestamp 联合起来,用于防止重放攻击。建议携带此参数进一步提升API安全性。 sign_type=hmacsha1时此参数有效。 |
客户自行生成随机正整数,如random.randint(1, 100000000) |
| f_id新 | 是 | 指定的独享代理ID | 查看独享代理ID |
3. 调用示例
在会员中心API密钥管理页得到订单的SecretId和SecretKey:
- SecretId:
o1fjh1re9o28876h7c08 - SecretKey:
jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
以密钥令牌验证为例,调用获取密钥令牌接口得到密钥令牌:
- SecretToken:
oxf0n0g59h7wcdyvz2uo68ph2s
调用示例
GET https://kps.kdlapi.com/api/getkpsbyid?secret_id=o1fjh1re9o28876h7c08
&signature=oxf0n0g59h7wcdyvz2uo68ph2s&f_id=lrps-49994
使用说明
点击查看关于API授权与验证的介绍
4. 返回结果
接口可返回文本格式、json格式、xml格式,字段说明如下:
| 参数 | 说明 |
|---|---|
| code | 返回码。取值:0代表成功 非0代表失败 |
| msg | 错误信息 |
| data | 包含接口返回的数据 |
| data.ip | 指定机器的ip地址 |
| data.port | 指定机器的端口号 |
| data.public_ip | 指定机器的真实ip地址(纯生版返回) |
异常返回错误码和错误提示,格式 ERROR(错误码): 错误提示
格式样例:
ERROR(-1): 参数错误
json格式
正常返回格式样例:
{
"msg": "",
"code": 0,
"data": {
"ip": "218.95.37.135",
"port": "10272",
"public_ip": "175.160.149.129"
}
}
异常返回格式样例:
{"code": -1, "msg": "参数错误", "data": ""}
5. 错误码一览
| 错误码 | 说明 |
|---|---|
| 2 | 订单已过期 |
| 3 | 没有找到符合条件的代理 |
| 4 | 账号尚未通过实名认证 |
| -1 | 无效请求 |
| -2 | 订单无效。如果刚下单,请耐心等待一会儿,1分钟内订单会自动生效。 |
| -3 | 参数错误 |
| -4 | 提取失败: $err_msg |
| -5 | 此订单不能提取独享代理。 |
| -51 | 此订单1分钟内允许最多$ip_number个ip调用 |
| -16 | 订单已退款 |
| -15 | 订单已过期 |
| -14 | 订单被封禁,请联系客服处理 |
| -13 | 订单已过期 |
| -12 | 订单无效 |
| -11 | 订单尚未支付 |
6. SDK
快代理提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。