获取订单IP提取余额

1. 接口描述

https://dps.kdlapi.com/api/getipbalance 英文代号:get ip balance

获取私密代理订单IP余额。

此接口只对按量付费订单和包年包月的集中提取型订单有效:
• 对于按量付费订单,此接口返回的是订单的剩余IP提取额度。
• 对于包年包月的集中提取型订单,此接口返回的是今日剩余的IP提取额度。

  1. HTTP GET接口
  2. 参数和返回内容均采用utf-8编码
  3. 接口最快调用频率: 1秒10次

2. 参数说明

参数 是否必填 参数说明 取值说明
orderid 订单号 私密代理订单号。查看我的订单
sign_type 签名验证方式。目前支持simple和hmacsha1。 默认值:simple
signature 请求签名,用来验证此次请求的合法性。 支持2种签名验证方式,签名计算方法参见API 授权与验证
timestamp 当前 UNIX 时间戳(秒级),可记录发起 API 请求的时间。
sign_type=hmacsha1时此参数为必填项。
例如1557546010,如果与当前时间相差过大,会引起签名过期错误。

3. 返回结果

接口返回json格式,样例:{"code": 0, "msg": "success", "data": {“balance”: 3000}}

字段说明如下:

参数 说明
code 返回码。取值:0代表成功 非0代表失败
msg 错误信息
data.balance ip提取余额

4. 错误码一览

错误码 说明
-1 缺少参数
-2 订单类型错误

5. 示例

订单号:965102959536478
使用简单签名验证
在会员中心订单API接口页面查看到订单的API Key为jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

调用示例

orderid=965102959536478signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c&拼接起来作为参数即可生成API链接:

https://dps.kdlapi.com/api/getipbalance?orderid=965102959536478&signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

返回示例

{"msg": "", "code": 0, "data": {"balance": 940}}

6. SDK

快代理提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

SDK下载