开启/关闭自动续费
1. 接口描述
https://dev.kdlapi.com/api/setautorenew 英文代号：set auto renew
本接口用于对包年包月(预付费)订单开启/关闭自动续费。
一次调用限设置一个订单，如需设置多个订单请分多次调用本接口。
自动续费设置成功后，续费费用将从账户余额里自动结算，请提前充值确保余额充足。
- 必须使用订单API密钥调用本接口
- 接口最快调用频率：1秒1次
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) |
| autorenew | 是 | 开启/关闭自动续费 | 1: 开启 0: 关闭 |
| time_type | 否 | 自动续费时长 autorenew=1时此参数生效 |
DAY: 按天自动续费 WEEK: 按周自动续费 MONTH: 按月自动续费(默认) YEAR: 按年自动续费 |
3. 调用示例
在会员中心API密钥管理页得到订单的SecretId和SecretKey：
- SecretId：
o1fjh1re9o28876h7c08 - SecretKey：
jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
以密钥令牌验证为例，调用获取密钥令牌接口得到密钥令牌：
- SecretToken：
oxf0n0g59h7wcdyvz2uo68ph2s
开启按月自动续费
调用示例
GET https://dev.kdlapi.com/api/setautorenew?secret_id=o1fjh1re9o28876h7c08
&autorenew=1
&time_type=MONTH
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
返回示例
{"msg": "autorenew by month enabled", "code": 0, "data": ""}
关闭自动续费
调用示例
GET https://dev.kdlapi.com/api/setautorenew?secret_id=o1fjh1re9o28876h7c08
&autorenew=0
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
返回示例
{"msg": "autorenew disabled", "code": 0, "data": ""}
使用说明
点击查看关于API授权与验证的介绍
4. 返回结果
接口返回json格式，样例：
{
"msg": "autorenew by month enabled",
"code": 0,
"data": ""
}
异常返回格式样例：
{"code": -1, "msg": "参数错误", "data": ""}
5. 错误码一览
| 错误码 | 说明 |
|---|---|
| -3 | 订单类型错误 |
6. SDK
快代理提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。