续费订单
1. 接口描述
https://dev.kdlapi.com/api/reneworder 英文代号:renew order
本接口用于续费订单,自动从账户余额里结算费用。
续费订单仅限包年包月
和私密代理按IP付费
订单,按量付费(后付费)
订单不支持续费。
一次调用限续费一个订单,如需续费多个订单请分多次调用本接口。(请提前充值确保账户余额充足)
- HTTP POST / GET 都支持
- 参数和返回内容均采用utf-8编码
- 接口最快调用频率: 1秒1次
安全提示
此接口为敏感操作,建议的调用方式:
1. 使用https调用接口,请求和返回的内容不容易被监听和泄露。
2. 使用数字签名验证调用接口,更加安全。
2. 参数说明
公共参数
参数 | 是否必填 | 参数说明 | 取值说明 |
---|---|---|---|
orderid | 是 | 订单号 | 有效的订单号。查看我的订单 |
sign_type | 否 | 签名验证方式。目前支持simple和hmacsha1。 | 默认值:simple |
signature | 是 | 请求签名,用来验证此次请求的合法性。 | 支持2种签名验证方式,签名计算方法参见API 授权与验证 |
timestamp | 否 | 当前 UNIX 时间戳(秒级),可记录发起 API 请求的时间。 sign_type=hmacsha1时此参数为必填项。 |
例如1557546010,如果与当前时间相差过大,会引起签名过期错误。 |
is_notify | 否 | 订单续费成功后是否发送通知。 | 1: 发送通知(默认) 0: 不发通知 |
time_type | 否 | 时长类型选择 此参数只对 包年包月 订单有效,且为必填项 |
DAY: 包天 WEEK: 包周 MONTH: 包月 YEAR: 包年 注:独享代理IP独享型订单续费只支持包月和包年 |
time_number | 否 | 时长数量 此参数只对 包年包月 订单有效,且为必填项 |
取值范围: • 包天:1~15 • 包周:1~3 • 包月:1~9 • 包年:1~3 默认取值:1 |
is_auto_renew | 否 | 是否开启自动续费 开启后下次订单到期前将自动续费 此参数只对 包年包月 订单有效 |
0: 不开启(默认) 1: 开启 |
auto_renew_unit | 否 | 自动续费时长 此参数只对 包年包月 订单有效is_auto_renew=1时此参数生效 |
DAY: 按天自动续费 WEEK: 按周自动续费 MONTH: 按月自动续费(默认) YEAR: 按年自动续费 注:独享代理IP独享型只支持按月和按年自动续费 |
dps.ip_count | 否 | 续费IP量 此参数只对 私密代理按IP付费 订单有效,且为必填项 |
按IP付费取值范围: • 1~5分钟: 1000~100万 (1000的整数倍) • 5~10分钟: 1000~100万 (1000的整数倍) • 10~20分钟: 1000~100万 (1000的整数倍) • 20~30分钟: 1000~100万 (1000的整数倍) • 30~60分钟: 1000~100万 (1000的整数倍) • 1~60分钟: 1000~100万 (1000的整数倍) • 2~4小时: 100~10万 (100的整数倍) |
3. 调用示例
在会员中心订单API接口页面得到订单号和API Key。
- 订单号:965102959536478
- apikey:
jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
为演示简单,这里采用密钥明文验证生成签名参数,建议您在生产环境采用数字签名验证。
续费包年包月订单
续费1个月,后续不自动续费。
调用示例
GET https://dev.kdlapi.com/api/reneworder?orderid=399141692192336
&time_type=MONTH
&time_number=1
&signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
续费包年包月订单并设置自动续费
续费1周,后续自动按周续费。
调用示例
GET https://dev.kdlapi.com/api/reneworder?orderid=399141692192336
&time_type=WEEK
&time_number=1
&is_auto_renew=1
&auto_renew_unit=WEEK
&signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
续费私密代理按IP付费订单
为订单续费10000IP。
调用示例
GET https://dev.kdlapi.com/api/reneworder?orderid=399141692192336
&dps.ip_count=100000
&signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
4. 返回结果
接口返回json格式,样例:
{
"msg": "renew order success",
"code": 0,
"data": {
"orderid": "399141692192336",
"expire_time": "2022-08-16 14:24:33",
"ip_balance": 11542 #仅对私密代理按IP付费订单返回此字段
}
}
异常返回格式样例:
{"code": -1, "msg": "缺少参数", "data": ""}
5. 错误码一览
错误码 | 说明 |
---|---|
-1 | 缺少参数 |
-2 | 参数错误 |
-3 | 后付费订单不支持续费 |
-4 | 虚拟订单号不支持续费订单操作 |
-5 | 余额不足 |
6. SDK
快代理提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。