获取IP白名单
1. 接口描述
https://dev.kdlapi.com/api/getipwhitelist 英文代号:get ip whitelist
获取订单的IP白名单。
- HTTP GET接口
- 参数和返回内容均采用utf-8编码
- 接口最快调用频率: 1秒10次
- 支持私密代理 / 隧道代理 / 独享代理 / 开放代理专业版订单
2. 参数说明
参数 | 是否必填 | 参数说明 | 取值说明 |
---|---|---|---|
orderid | 是 | 订单号 | 有效的订单号。查看我的订单 |
sign_type | 否 | 签名验证方式。目前支持simple和hmacsha1。 | 默认值:simple |
signature | 是 | 请求签名,用来验证此次请求的合法性。 | 支持2种签名验证方式,签名计算方法参见API 授权与验证 |
timestamp | 否 | 当前 UNIX 时间戳(秒级),可记录发起 API 请求的时间。 sign_type=hmacsha1时此参数为必填项。 |
例如1557546010,如果与当前时间相差过大,会引起签名过期错误。 |
3. 返回结果
接口返回json格式,样例:{"msg": "", "code": 0, "data": {"count": 2, "ipwhitelist": ["123.35.67.46", "223.57.8.100"], "limit": 2}}
字段说明如下:
参数 | 说明 |
---|---|
code | 返回码。取值:0代表成功 非0代表失败 |
msg | 错误信息 |
data.count | 白名单IP数量 |
data.ipwhitelist | IP白名单列表 |
data.limit | 可设置的IP白名单数量上限 |
4. 错误码一览
错误码 | 说明 |
---|---|
-3 | 订单类型错误,只支持私密代理、隧道代理、独享代理订单 |
5. 示例
订单号:965102959536478
使用简单签名验证
在会员中心订单API接口页面查看到订单的API Key为jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
调用示例
将orderid=965102959536478
、signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
用&
拼接起来作为参数即可生成API链接:
https://dev.kdlapi.com/api/getipwhitelist?orderid=965102959536478&signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
返回示例
{"msg": "", "code": 0, "data": {"count": 1, "ipwhitelist": ["220.155.1.196"], "limit": 2}}
6. SDK
快代理提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。