獲取訂單信息

1. 接口描述

https://dev.kdlapi.com/api/getorderinfo 英文代號：get order info

獲取訂單的詳細信息。

必須使用訂單API密鑰調用本接口
接口最快調用頻率: 1秒5次

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)
field_list	否	自定義只返回指定的字段	填寫字段名稱，指定多個字段用英文逗號分隔，字段集合參見下方的返回結果說明值為空則返回所有應返回的字段

3. 調用示例

在會員中心API密鑰管理頁得到訂單的SecretId和SecretKey：

SecretId：o1fjh1re9o28876h7c08
SecretKey：jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

以密鑰令牌驗證為例，調用獲取密鑰令牌接口得到密鑰令牌：

SecretToken：oxf0n0g59h7wcdyvz2uo68ph2s

調用示例

GET https://dev.kdlapi.com/api/getorderinfo?secret_id=o1fjh1re9o28876h7c08
&signature=oxf0n0g59h7wcdyvz2uo68ph2s

使用說明

點擊查看關于API授權與驗證的介紹

4. 返回結果

接口返回json格式，樣例：

{
  "msg": "",
  "code": 0,
  "data": {
    "orderid": "965102959536478",
    "pay_type": "POST_PAY",
    "product": "TPS",
    "status": "VALID",
    "freeze_amount": "2.68",
    "unit_price": "2.68",
    "tunnel_password": "beot3nx1",
    "tunnel_username": "t12926732052681",
    "tunnel_host": "tps119.kdlapi.com",
    "tunnel_port_http": "12306",
    "tunnel_port_socks": "",
    "tunnel_bandwidth": 10,
    "tunnel_req": 20
  }
}

字段說明如下：

錯誤碼	說明
code	返回碼。取值：0代表成功非0代表失敗
msg	錯誤信息
data	字典格式，包含訂單詳細信息，參見下方的說明。

公共字段

字段	字段說明	取值說明
orderid	訂單號
pay_type	付費方式	PRE_PAY: 包年包月(預付費) PRE_PAY_IP: 按IP付費(預付費) POST_PAY: 按量付費(后付費)
product	產品類型	TPS: 隧道代理 DPS: 私密代理 KPS: 獨享代理
status	訂單狀態	VALID: 有效 WAIT_PAY: 待支付 OPENING: 開通中 EXPIRED: 已過期 OWING: 欠費暫停 CLOSED: 已關閉 FORBIDDEN: 被封禁
expire_time	訂單到期時間僅對包年包月(預付費)訂單返回此字段	格式：2021-08-18 12:01:43
is_auto_renew	是否開啟自動續費僅對包年包月(預付費)訂單返回此字段	布爾值，true或false
auto_renew_time_type	自動續費時長 is_auto_renew=true時返回此字段	DAY: 按天自動續費 WEEK: 按周自動續費 MONTH: 按月自動續費 YEAR: 按年自動續費
freeze_amount	訂單凍結的金額僅對按量付費(后付費)訂單返回此字段	單位：元 (保留兩位小數) 例如：36.28
unit_price	計費單價僅對按量付費(后付費)訂單返回此字段	單位：元 (保留兩位小數) 例如：1.95

隧道代理相關字段

字段	字段說明	取值說明
tunnel_host	隧道host
tunnel_port_http	隧道http端口
tunnel_port_socks	隧道socks端口	賬號通過實名認證會返回socks端口號，否則返回空串
tunnel_username	隧道用戶名
tunnel_password	隧道密碼
tunnel_period	隧道換IP周期	單位：s
tunnel_bandwidth	隧道帶寬	單位：Mb/s
tunnel_req	隧道并發量	單位：次/s

私密代理相關字段

字段	字段說明	取值說明
proxy_username	私密代理用戶名
proxy_password	私密代理密碼

獨享代理相關字段

字段	字段說明	取值說明
proxy_count	此訂單下的獨享代理數量
proxy_username	獨享代理用戶名
proxy_password	獨享代理密碼

海外動態代理

字段	字段說明	取值說明
proxy_username	海外動態代理用戶名
proxy_password	海外動態代理密碼
transfer_area	轉發地區
fps_host	隧道host
fps_port_http	隧道http端口
fps_port_socks	隧道socks端口

海外靜態代理

字段	字段說明	取值說明
proxy_username	海外靜態代理用戶名	包段訂單返回此字段
proxy_password	海外靜態代理密碼	包段訂單返回此字段
proxy_count	此訂單下的海外靜態代理數量

5. 錯誤碼一覽

錯誤碼	說明
-4	虛擬訂單號不支持獲取訂單信息

6. SDK

快代理提供了配套的開發工具集（SDK），支持多種編程語言，能更方便的調用 API。

SDK下載