獲取賬戶訂單列表
1. 接口描述
https://dev.kdlapi.com/api/getaccountorders 英文代號(hào):get account orders
獲取快代理賬戶下的訂單列表。
- 必須使用賬戶API密鑰調(diào)用本接口
- 接口最快調(diào)用頻率:1秒1次
2. 參數(shù)說(shuō)明
| 參數(shù) | 是否必填 | 參數(shù)說(shuō)明 | 取值說(shuō)明 |
|---|---|---|---|
| secret_id | 是 | 賬戶SecretId | 查看賬戶API密鑰信息 |
| sign_type | 否 | 簽名驗(yàn)證方式。目前支持token和hmacsha1。 | 默認(rèn)值:token |
| signature | 是 | 請(qǐng)求簽名,用來(lái)驗(yàn)證此次請(qǐng)求的合法性。 | 支持2種簽名驗(yàn)證方式,簽名計(jì)算方法參見(jiàn)API 授權(quán)與驗(yàn)證 |
| timestamp | 否 | 當(dāng)前 UNIX 時(shí)間戳(秒級(jí)),可記錄發(fā)起 API 請(qǐng)求的時(shí)間。 sign_type=hmacsha1時(shí)此參數(shù)有效且為必填項(xiàng)。 |
例如1557546010,如果與當(dāng)前時(shí)間相差過(guò)大,會(huì)引起簽名過(guò)期錯(cuò)誤。 |
| nonce | 否 | 隨機(jī)正整數(shù),與 timestamp 聯(lián)合起來(lái),用于防止重放攻擊。建議攜帶此參數(shù)進(jìn)一步提升API安全性。 sign_type=hmacsha1時(shí)此參數(shù)有效。 |
客戶自行生成隨機(jī)正整數(shù),如random.randint(1, 100000000) |
| status | 否 | 訂單狀態(tài) 不傳此參數(shù)代表返回當(dāng)前生效中的訂單。 |
ALL: 所有狀態(tài) VALID: 有效(默認(rèn)) WAIT_PAY: 待支付 OPENING: 開(kāi)通中 EXPIRED: 已過(guò)期 OWING: 欠費(fèi)暫停 CLOSED: 已關(guān)閉 FORBIDDEN: 被封禁 |
| pay_type | 否 | 付費(fèi)方式 | PRE_PAY: 包年包月(預(yù)付費(fèi)) PRE_PAY_IP: 按IP付費(fèi)(預(yù)付費(fèi)) POST_PAY: 按量付費(fèi)(后付費(fèi)) |
| product | 否 | 產(chǎn)品類型 | TPS: 隧道代理 DPS: 私密代理 KPS: 獨(dú)享代理 |
3. 調(diào)用示例
在會(huì)員中心API密鑰管理頁(yè)得到賬戶的SecretId和SecretKey:
- SecretId:
o1fjh1re9o28876h7c08 - SecretKey:
jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
以密鑰令牌驗(yàn)證為例,調(diào)用獲取密鑰令牌接口得到密鑰令牌:
- SecretToken:
oxf0n0g59h7wcdyvz2uo68ph2s
調(diào)用示例
GET https://dev.kdlapi.com/api/getaccountorders?secret_id=o1fjh1re9o28876h7c08
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
使用說(shuō)明
點(diǎn)擊查看關(guān)于API授權(quán)與驗(yàn)證的介紹
4. 返回結(jié)果
接口返回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密鑰類型錯(cuò)誤,請(qǐng)使用賬戶API密鑰", "data": ""}
5. 錯(cuò)誤碼一覽
| 錯(cuò)誤碼 | 說(shuō)明 |
|---|---|
| -1 | 缺少參數(shù) |
| -2 | 參數(shù)錯(cuò)誤 |
| -3 | API密鑰類型錯(cuò)誤,請(qǐng)使用賬戶API密鑰 |
| -4 | 未獲取到符合條件的訂單 |
6. SDK
快代理提供了配套的開(kāi)發(fā)工具集(SDK),支持多種編程語(yǔ)言,能更方便的調(diào)用 API。