获取订单信息

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	独享代理密码

5. 错误码一览

错误码	说明
-4	虚拟订单号不支持获取订单信息

6. SDK

快代理提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

SDK下载