创建订单

1. 接口描述

https://dev.kdlapi.com/api/createorder 英文代号:create order

本接口用于创建订单,自动从账户余额里结算费用。
一次调用限创建一个订单,如需创建多个订单请分多次调用本接口。(请提前充值确保账户余额充足)

  1. HTTP POST / GET 都支持
  2. 参数和返回内容均采用utf-8编码
  3. 接口最快调用频率: 1秒1次
  4. 必须使用虚拟订单号调用本接口

安全提示

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

2. 参数说明

公共参数

参数 是否必填 参数说明 取值说明
orderid 订单号 虚拟订单号。查看虚拟订单号
sign_type 签名验证方式。目前支持simple和hmacsha1。 默认值:simple
signature 请求签名,用来验证此次请求的合法性。 支持2种签名验证方式,签名计算方法参见API 授权与验证
timestamp 当前 UNIX 时间戳(秒级),可记录发起 API 请求的时间。
sign_type=hmacsha1时此参数为必填项。
例如1557546010,如果与当前时间相差过大,会引起签名过期错误。
is_notify 订单创建成功后是否发送通知。 1: 发送通知(默认)
0: 不发通知
product 开通的产品类型 TPS: 隧道代理
DPS: 私密代理
KPS: 独享代理
OPS: 开放代理
pay_type 付费方式 PRE_PAY: 包年包月(预付费)
PRE_PAY_IP: 按IP付费(预付费)仅支持私密代理
POST_PAY: 按量付费(后付费)仅支持隧道代理

以下为开通包年包月(预付费)订单时所需的参数

参数 是否必填 参数说明 取值说明
prepay.time_type 时长类型选择 DAY: 包天
WEEK: 包周
MONTH: 包月
YEAR: 包年

注:独享代理IP独享型只支持包月和包年

prepay.time_number 时长数量 取值范围:
• 包天:1~15
• 包周:1~3
• 包月:1~9
• 包年:1~3
默认取值:1
prepay.is_auto_renew 是否开启自动续费
pay_type=PRE_PAY时此参数生效
0: 不开启(默认)
1: 开启
prepay.auto_renew_unit 自动续费时长
prepay.is_auto_renew=1时此参数生效
DAY: 按天自动续费
WEEK: 按周自动续费
MONTH: 按月自动续费(默认)
YEAR: 按年自动续费

注:独享代理IP独享型只支持按月和按年自动续费

隧道代理相关参数

参数 是否必填 参数说明 取值说明
tps.period 换IP周期(秒) 有效取值:
• 0: 每次请求换IP
• 15: 15秒
• 30: 30秒
• 60: 1分钟
• 300:5分钟
• 600:10分钟
• 900:15分钟
• 1800:30分钟
• 3600:1小时
• 21600:6小时
• 43200:12小时
• 86400:24小时
tps.max_rps 并发请求数 取值范围:5~1000 (默认值: 5)
tps.max_bandwidth 带宽规格 tps.period = 0,取值范围:5~80 (默认值: 5)
15 <= tps.period <= 3600,取值范围:3~10 (默认值: 3)
tps.period >= 21600,取值固定为3

私密代理相关参数

参数 是否必填 参数说明 取值说明
dps.fetch_type IP提取方式
pay_type=PRE_PAY时此参数生效
并且为必填项
1: 均匀提取
2: 集中提取
dps.period IP有效时长 均匀提取(包年包月)有效取值:
• M_3_5:3~5分钟
• M_10_30:10~30分钟
• M_30_60:30~60分钟
• H_3_4:3~4小时

集中提取(包年包月)有效取值:
• M_1_5:1~5分钟
• M_5_10:5~10分钟
• M_10_20:10~20分钟
• M_20_30:20~30分钟
• M_30_60:30~60分钟
• H_2_4:2~4小时

按IP付费有效取值:
• M_1_5:1~5分钟
• M_5_10:5~10分钟
• M_10_20:10~20分钟
• M_20_30:20~30分钟
• M_30_60:30~60分钟
• M_1_60:1~60分钟
• H_2_4:2~4小时
dps.ip_count 每天IP量(包年包月)
购买IP量(按IP付费)
取值范围根据产品型号的不同而不同

均匀提取(包年包月)取值范围:
• 3~5分钟: 2500~150000 (2500的整数倍)
• 10~30分钟: 1000~17000 (1000的整数倍)
• 30~60分钟: 1000~25000 (1000的整数倍)
• 3~4小时: 100~1000 (100的整数倍)

集中提取(包年包月)取值范围:
• 1~5分钟: 1000~200000 (1000的整数倍)
• 5~10分钟: 1000~50000 (1000的整数倍)
• 10~20分钟: 1000~30000 (1000的整数倍)
• 20~30分钟: 1000~25000 (1000的整数倍)
• 30~60分钟: 1000~25000 (1000的整数倍)
• 2~4小时: 100~500 (100的整数倍)

按IP付费取值范围:
• 1~5分钟: 1000~100万 (1000的整数倍)
• 5~10分钟: 1000~100万 (1000的整数倍)
• 10~20分钟: 1000~100万 (1000的整数倍)
• 20~30分钟: 1000~100万 (1000的整数倍)
• 30~60分钟: 1000~100万 (1000的整数倍)
• 1~60分钟: 1000~100万 (1000的整数倍)
• 2~4小时: 100~10万 (100的整数倍)
dps.whiteip_count IP白名单数量 取值范围:2~120 (默认值: 2)

独享代理相关参数

参数 是否必填 参数说明 取值说明
kps.serie 独享类型 1: IP共享型
2: IP独享型
kps.model 型号选择
kps.serie=1时此参数生效并且为必填项
DYN: 动态型
STD: 标准型
PRO: 专业型
ENT: 企业型
kps.city 城市选择
指定开通某个城市的IP
取值为2~4位城市编码(参见中国地区编码表)
默认取值:空串
取值为空串或不带此参数代表随机分配城市
可通过查询接口得知有哪些城市可供开通以及每个城市可开通的IP数量
kps.max_bandwidth 带宽选择
kps.serie=2时此参数生效并且为必填项
1:1Mb/s
2:2Mb/s
4:4Mb/s
kps.ip_count 购买IP量 kps.serie=1 取值范围:1~N
  • N为查询接口得到的可供开通的最大IP量
kps.serie=2 取值范围:1~10
kps.whiteip_count IP白名单数量 kps.serie=1 取值范围:2~120 (默认值: 2)
kps.serie=2 取值范围:20~120 (默认值: 20)

开放代理相关参数

参数 是否必填 参数说明 取值说明
ops.plan 套餐选择 1:普通套餐
2:VIP套餐
3:SVIP套餐
4:专业版套餐

3. 调用示例

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

  • 虚拟订单号:399141692192336
  • apikey:jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

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

购买隧道包年包月

每次换IP周期为1分钟的隧道,并发请求数为10次/s,带宽3Mb/s,购买1个月,不自动续费。

调用示例

GET https://dev.kdlapi.com/api/createorder?orderid=399141692192336
&product=TPS
&pay_type=PRE_PAY
&prepay.time_type=MONTH
&prepay.time_number=1
&tps.period =60
&tps.max_rps=10
&tps.max_bandwidth=3
&signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

购买隧道按量付费

开通每次请求更换IP的隧道,并发请求数为100次/s,带宽10Mb/s。

调用示例

GET https://dev.kdlapi.com/api/createorder?orderid=399141692192336
&product=TPS
&pay_type=POST_PAY
&tps.period =0
&tps.max_rps=100
&tps.max_bandwidth=10
&signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

购买私密代理包年包月

集中提取5~10分钟,每天IP量5000,IP白名单10个,购买1周,按周自动续费。

调用示例

GET https://dev.kdlapi.com/api/createorder?orderid=399141692192336
&product=DPS
&pay_type=PRE_PAY
&prepay.time_type=WEEK
&prepay.time_number=1
&prepay.is_auto_renew=1
&prepay.auto_renew_unit=WEEK
&dps.fetch_type=2
&dps.period=M_5_10
&dps.ip_count=5000
&dps.whiteip_count=10
&signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

购买私密代理按IP付费

买10万个可用时长1~5分钟的IP,IP白名单10个。

调用示例

GET https://dev.kdlapi.com/api/createorder?orderid=399141692192336
&product=DPS
&pay_type=PRE_PAY_IP
&dps.period=M_1_5
&dps.ip_count=100000
&dps.whiteip_count=10
&signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

购买IP共享型独享代理

1个郑州市的标准型IP,5个白名单,购买1个月,按月自动续费。

调用示例

GET https://dev.kdlapi.com/api/createorder?orderid=399141692192336
&product=KPS
&pay_type=PRE_PAY
&prepay.time_type=MONTH
&prepay.time_number=1
&prepay.is_auto_renew=1
&prepay.auto_renew_unit=MONTH
&kps.serie=1
&kps.model=STD
&kps.city=4101
&kps.ip_count=1
&kps.whiteip_count=5
&signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

购买IP独享型独享代理

1个带宽4M的IP,城市随机分配,白名单数量默认,购买1个月,不自动续费。

调用示例

GET https://dev.kdlapi.com/api/createorder?orderid=399141692192336
&product=KPS
&pay_type=PRE_PAY
&prepay.time_type=MONTH
&prepay.time_number=1
&kps.serie=2
&kps.max_bandwidth=4
&kps.ip_count=1
&signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

购买开放代理

购买一周的SVIP套餐,不自动续费。

调用示例

GET https://dev.kdlapi.com/api/createorder?orderid=399141692192336
&product=OPS
&pay_type=PRE_PAY
&prepay.time_type=WEEK
&prepay.time_number=1
&ops.plan=3
&signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

4. 返回结果

接口返回json格式,样例:

{
  "msg": "create order success",
  "code": 0,
  "data": {
    "orderid": "965102959536478",
    "apikey": "jd1gzm6ant2u7pojhbtl0bam0xpzsm1c"
  }
}

异常返回格式样例:

{"code": -1, "msg": "缺少参数", "data": ""}

5. 错误码一览

错误码 说明
-1 缺少参数
-2 参数值错误
-3 订单类型错误,必须使用虚拟订单号
-4 账户余额不足
-61 暂无IP可供购买
-62 kps.ip_count超过了可供购买的最大IP数量
-71 未满足开通隧道按量付费订单的条件
-72 开通隧道按量付费订单出现错误

6. SDK

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

SDK下载

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