获取账户订单列表
1. 接口描述
https://dev.kdlapi.com/api/getaccountorders 英文代号:get account orders
获取快代理账户下的订单列表。
- 必须使用账户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) |
status | 否 | 订单状态 不传此参数代表返回当前生效中的订单。 |
ALL: 所有状态 VALID: 有效(默认) WAIT_PAY: 待支付 OPENING: 开通中 EXPIRED: 已过期 OWING: 欠费暂停 CLOSED: 已关闭 FORBIDDEN: 被封禁 |
pay_type | 否 | 付费方式 | PRE_PAY: 包年包月(预付费) PRE_PAY_IP: 按IP付费(预付费) POST_PAY: 按量付费(后付费) |
product | 否 | 产品类型 | TPS: 隧道代理 DPS: 私密代理 KPS: 独享代理 |
3. 调用示例
在会员中心API密钥管理页得到账户的SecretId和SecretKey:
- SecretId:
o1fjh1re9o28876h7c08
- SecretKey:
jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
以密钥令牌验证为例,调用获取密钥令牌接口得到密钥令牌:
- SecretToken:
oxf0n0g59h7wcdyvz2uo68ph2s
调用示例
GET https://dev.kdlapi.com/api/getaccountorders?secret_id=o1fjh1re9o28876h7c08
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
使用说明
点击查看关于API授权与验证的介绍
4. 返回结果
接口返回json格式,样例:
{
"msg": "",
"code": 0,
"data": [
{
"orderid": "399141692192336",
"pay_type": "PRE_PAY",
"product": "DPS",
"status": "VALID",
"expire_time": "2022-06-18 12:01:43"
},
{
"orderid": "3991416921923356",
"pay_type": "POST_PAY",
"product": "TPS",
"status": "VALID"
}
]
}
异常返回格式样例:
{"code": -3, "msg": "API密钥类型错误,请使用账户API密钥", "data": ""}
5. 错误码一览
错误码 | 说明 |
---|---|
-1 | 缺少参数 |
-2 | 参数错误 |
-3 | API密钥类型错误,请使用账户API密钥 |
-4 | 未获取到符合条件的订单 |
6. SDK
快代理提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。