设置IP白名单
1. 接口描述
https://dev.kdlapi.com/api/setipwhitelist 英文代号：set ip whitelist
设置订单的IP白名单。
温馨提示
如需把本机IP加入白名单，可调用接口获取本机IP。
- HTTP POST / GET 都支持
- 参数和返回内容均采用utf-8编码
- 接口最快调用频率: 1秒1次
- 支持私密代理 / 隧道代理 / 独享代理订单
2. 参数说明
| 参数 | 是否必填 | 参数说明 | 取值说明 |
|---|---|---|---|
| orderid | 是 | 订单号 | 有效的订单号。查看我的订单 |
| iplist | 否 | IP列表 | 待设置的IP列表，多个IP用英文逗号分隔。例如：183.57.42.79,183.57.42.79 不带此参数代表设置您的当前IP作为白名单 |
| sign_type | 否 | 签名验证方式。目前支持simple和hmacsha1。 | 默认值：simple |
| signature | 是 | 请求签名，用来验证此次请求的合法性。 | 支持2种签名验证方式，签名计算方法参见API 授权与验证 |
| timestamp | 否 | 当前 UNIX 时间戳（秒级），可记录发起 API 请求的时间。 sign_type=hmacsha1时此参数为必填项。 |
例如1557546010，如果与当前时间相差过大，会引起签名过期错误。 |
3. 调用示例
在会员中心订单API接口页面得到订单号和API Key。
- 订单号：965102959536478
- apikey：
jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
为演示简单，这里采用密钥明文验证生成签名参数，建议您在生产环境采用数字签名验证。
调用示例
为订单设置如下两个IP为白名单：183.57.42.79, 183.57.42.79
GET https://dev.kdlapi.com/api/setipwhitelist?orderid=965102959536478
&iplist=183.57.42.79,183.57.42.79
&signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
4. 返回结果
接口返回json格式，样例：
{
"code": 0,
"msg": "ip whitelist updated to 183.57.42.79,183.57.42.79",
"data": ""
}
字段说明如下：
| 参数 | 说明 |
|---|---|
| code | 返回码。取值：0代表成功 非0代表失败 |
| msg | 错误信息 |
| data | 空串 |
5. 错误码一览
| 错误码 | 说明 |
|---|---|
| -1 | 缺少参数 |
| -3 | 订单类型错误，只支持私密代理、隧道代理、独享代理订单 |
| -4 | iplist参数中的IP格式错误 |
| -5 | 待设置的ip数量超出了上限 |
| -6 | iplist包含内网IP，只允许设置外网IP |
6. SDK
快代理提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
