获取订单信息

1. 接口描述

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

获取订单的详细信息。

  1. HTTP GET接口
  2. 参数和返回内容均采用utf-8编码
  3. 接口最快调用频率: 1秒5次

安全提示

此接口为敏感操作,建议的调用方式:
1. 使用https调用接口,请求和返回的内容不容易被监听和泄露。
2. 使用数字签名验证调用接口,更加安全。

2. 参数说明

参数 是否必填 参数说明 取值说明
orderid 订单号 有效的订单号。查看我的订单
sign_type 签名验证方式。目前支持simple和hmacsha1。 默认值:simple
signature 请求签名,用来验证此次请求的合法性。 支持2种签名验证方式,签名计算方法参见API 授权与验证
timestamp 当前 UNIX 时间戳(秒级),可记录发起 API 请求的时间。
sign_type=hmacsha1时此参数为必填项。
例如1557546010,如果与当前时间相差过大,会引起签名过期错误。
field_list 自定义只返回指定的字段 填写字段名称,指定多个字段用英文逗号分隔,字段集合参见下方的返回结果说明
值为空则返回所有应返回的字段

3. 调用示例

在会员中心订单API接口页面得到订单号和API Key。

  • 订单号:965102959536478
  • apikey:jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

为演示简单,这里采用密钥明文验证生成签名参数,建议您在生产环境采用数字签名验证。

调用示例

GET https://dev.kdlapi.com/api/getorderinfo?orderid=965102959536478
&signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

4. 返回结果

接口返回json格式,样例:

{
  "msg": "",
  "code": 0,
  "data": {
    "orderid": "965102959536478",
    "pay_type": "POST_PAY",
    "product": "TPS",
    "status": "VALID",
    "apikey": "jd1gzm6ant2u7pojhbtl0bam0xpzsm1c",
    "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": ""
  }
}

字段说明如下:

错误码 说明
code 返回码。取值:0代表成功 非0代表失败
msg 错误信息
data 字典格式,包含订单详细信息,参见下方的说明。

公共字段

字段 字段说明 取值说明
orderid 订单号
pay_type 付费方式 PRE_PAY: 包年包月(预付费)
PRE_PAY_IP: 按IP付费(预付费)
POST_PAY: 按量付费(后付费)
product 产品类型 TPS: 隧道代理
DPS: 私密代理
KPS: 独享代理
OPS: 开放代理
status 订单状态 VALID: 有效
WAIT_PAY: 待支付
OPENING: 开通中
EXPIRED: 已过期
OWING: 欠费暂停
CLOSED: 已关闭
FORBIDDEN: 被封禁
apikey 调用api所需的apikey 查看订单apikey
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 隧道密码

私密代理相关字段

字段 字段说明 取值说明
proxy_username 私密代理用户名
proxy_password 私密代理密码

独享代理相关字段

字段 字段说明 取值说明
proxy_count 此订单下的独享代理数量
proxy_username 独享代理用户名
proxy_password 独享代理密码

5. 错误码一览

无接口特定错误码,参见接口公共错误码

6. SDK

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

SDK下载

联系我们
  • 售前在线咨询
    咨询享免费测试,专业工程师提供技术支持
  • 客服热线
    400-058-0638  周一至周六 9:00-18:30
  • 提交工单
    您的每一次反馈我们都认真对待
  • 客服微信 & QQ
    客服微信:kuaidaili,客服QQ:800849628
  • 企业客户通道
    提交需求后专业的售前工程师为您提供服务