创建订单
1. 接口描述
https://dev.kdlapi.com/api/createorder 英文代号:create order
本接口用于创建订单,自动从账户余额里结算费用。
一次调用限创建一个订单,如需创建多个订单请分多次调用本接口。
- 调用本接口前请提前确保账户余额充足
- 必须使用账户API密钥调用本接口
- 接口最快调用频率: 1秒1次
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) |
is_notify | 否 | 订单创建成功后是否发送通知。 | 1: 发送通知(默认) 0: 不发通知 |
is_coupon | 否 | 是否使用优惠券。携带is_coupon=1参数会自动选中最优优惠券进行下单,没有可用优惠券时下单不受影响。 活动期间无法使用优惠券 |
1: 使用 0: 不使用(默认) |
product | 是 | 开通的产品类型 | TPS_PRO: 隧道代理Pro TPS: 隧道代理 DPS: 私密代理 KPS: 独享代理 FPS: 海外动态住宅 SFPS:海外静态住宅 |
pay_type | 是 | 付费方式 | PRE_PAY: 包年包月(预付费) PRE_PAY_IP: 按IP付费(预付费)仅支持私密代理 POST_PAY: 按量付费(后付费)仅支持隧道代理 |
以下为开通包年包月(预付费)订单时所需的参数
参数 | 是否必填 | 参数说明 | 取值说明 |
---|---|---|---|
prepay.time_type | 是 | 时长类型选择 | DAY: 包天 WEEK: 包周 MONTH: 包月 YEAR: 包年 注:独享代理IP独享型、海外静态代理只支持包月和包年 |
prepay.time_number | 否 | 时长数量 | 取值范围: • 包天:1~5 • 包周: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独享型只支持按月和按年自动续费 |
隧道代理Pro相关参数
参数 | 是否必填 | 参数说明 | 取值说明 |
---|---|---|---|
tps.max_rps | 是 | 并发请求数 | 取值范围:5~1000 (默认值: 5) |
隧道代理相关参数
参数 | 是否必填 | 参数说明 | 取值说明 |
---|---|---|---|
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次/s (默认值: 5) 注:tps.period >= 60 默认无限并发 |
tps.max_bandwidth | 否 | 带宽规格 | 0 <=tps.period <= 1800,取值范围:3~300Mb/s (默认值: 3) tps.period = 3600,取值范围:3~15 (默认值: 3) tps.period >= 21600,取值固定为3 注:购买时长小于1个月仅支持200M以下带宽 |
tps.ip_pool | 否 | IP资源池 | 1: 企业IP池(默认) 2: 星辰IP池 注:tps.period>=300时 tps.ip_pool仅可为1 |
私密代理相关参数
参数 | 是否必填 | 参数说明 | 取值说明 |
---|---|---|---|
dps.fetch_type | 否 | IP提取方式 pay_type=PRE_PAY时此参数生效 并且为必填项 |
1: 均匀提取 2: 集中提取 注:均匀提取和集中提取均属于包年包月(预付费)产品 |
dps.period | 是 | 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分钟 • H_2_4:2~4小时均匀提取固定时长有效取值: • M_1: 1分钟 • M_2: 2分钟 ... • M_30: 30分钟 按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分钟 • H_2_4:2~4小时 按IP付费专业版有效取值: • M_1: 1分钟 • M_2: 2分钟 ... • M_30: 30分钟 |
dps.ip_count | 是 | 每天IP量(包年包月) 购买IP量(按IP付费) |
取值范围根据产品型号的不同而不同均匀提取取值范围: • 1~5分钟: 2000~600000 (2000的整数倍) • 5~10分钟: 1000~250000 (1000的整数倍) • 10~20分钟: 1000~100000 (1000的整数倍) • 20~30分钟: 1000~20000 (1000的整数倍) • 30~60分钟: 1000~5000 (1000的整数倍) • 2~4小时: 100~1200 (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的整数倍) • 2~4小时: 100~10万 (100的整数倍) |
独享代理相关参数
参数 | 是否必填 | 参数说明 | 取值说明 |
---|---|---|---|
kps.serie | 是 | 独享类型 | 1: IP共享型 2: IP独享型 |
kps.model | 否 | 型号选择 kps.serie=1时此参数生效并且为必填项 |
DYN: 动态型 STA: 静态型 |
kps.city | 否 | 城市选择 指定开通某个城市的IP kps.model=STA时此参数生效 |
取值为2~4位城市编码(参见中国地区编码表) 默认取值:空串 取值为空串或不带此参数代表随机分配城市 可通过查询接口得知有哪些城市可供开通以及每个城市可开通的IP数量 |
kps.max_bandwidth | 是 | 带宽选择 | 有效取值: • 1:1Mb/s • 2:2Mb/s • 4:4Mb/s • 6:6Mb/s • 10:10Mb/s (kps.model=DYN 目前只支持1Mb/s) |
kps.ip_count | 是 | 购买IP量 | kps.serie=1 取值范围:1~N • N为查询接口得到的可供开通的最大IP量 kps.serie=2 取值范围:1~10 |
海外动态代理相关参数
参数 | 是否必填 | 参数说明 | 取值说明 |
---|---|---|---|
fps.serie | 是 | 付费模式 | 1:流量付费 2:包年包月 |
fps.flow | 否 | 流量选择 fps.serie=1时此参数生效并且为必填项 |
有效取值: • 1:1GB • 6:6GB • 10:10GB • 35:35GB • 110:110GB • 200:200GB • 500:500GB • 1000:1000GB |
fps.bw | 否 | 带宽选择 fps.serie=2时此参数生效并且为必填项 |
取值为5~50Mb/s(默认值:5) |
海外静态代理相关参数
参数 | 是否必填 | 参数说明 | 取值说明 |
---|---|---|---|
sfps.serie | 是 | 付费模式 | 1: 零售 2:包段 |
sfps.areas_select | 是 | 指定地区和数量。 | 取值为地区编码:数量 多个地区使用 | 隔开,如 US:1、US:1|JP:3 sfps.serie= 2 时可购买数量为50的倍数 单次开通的最大IP数量为2000 地区编码通过(查询接口)获得 |
3. 调用示例
在会员中心API密钥管理页得到账户的SecretId和SecretKey:
- SecretId:
o1fjh1re9o28876h7c08
- SecretKey:
jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
以密钥令牌验证为例,调用获取密钥令牌接口得到密钥令牌:
- SecretToken:
oxf0n0g59h7wcdyvz2uo68ph2s
购买隧道包年包月
每次换IP周期为1分钟的隧道,并发请求数为10次/s,带宽3Mb/s,购买1个月,不自动续费。
调用示例
GET https://dev.kdlapi.com/api/createorder?secret_id=o1fjh1re9o28876h7c08
&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=oxf0n0g59h7wcdyvz2uo68ph2s
购买隧道Pro包年包月
并发请求数为10次/s,购买1个月,不自动续费。
调用示例
GET https://dev.kdlapi.com/api/createorder?secret_id=o1fjh1re9o28876h7c08
&product=TPS_PRO
&pay_type=PRE_PAY
&prepay.time_type=MONTH
&prepay.time_number=1
&tps.max_rps=10
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
购买隧道按量付费
开通每次请求更换IP的隧道,并发请求数为100次/s,带宽10Mb/s。
调用示例
GET https://dev.kdlapi.com/api/createorder?secret_id=o1fjh1re9o28876h7c08
&product=TPS
&pay_type=POST_PAY
&tps.period=0
&tps.max_rps=100
&tps.max_bandwidth=10
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
购买私密代理包年包月
集中提取5~10分钟,每天IP量5000,购买1周,按周自动续费。
调用示例
GET https://dev.kdlapi.com/api/createorder?secret_id=o1fjh1re9o28876h7c08
&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
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
购买私密代理按IP付费标准版
买10万个可用时长1~5分钟的IP。
调用示例
GET https://dev.kdlapi.com/api/createorder?secret_id=o1fjh1re9o28876h7c08
&product=DPS
&pay_type=PRE_PAY_IP
&dps.period=M_1_5
&dps.ip_count=100000
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
购买私密代理按IP付费专业版
买10万个可用时长3分钟的IP。
调用示例
GET https://dev.kdlapi.com/api/createorder?secret_id=o1fjh1re9o28876h7c08
&product=DPS
&pay_type=PRE_PAY_IP
&dps.period=M_3
&dps.ip_count=100000
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
购买IP共享型独享代理
1个郑州市的标准型IP,购买1个月,按月自动续费。
调用示例
GET https://dev.kdlapi.com/api/createorder?secret_id=o1fjh1re9o28876h7c08
&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
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
购买IP独享型独享代理
1个带宽4M的IP,城市随机分配,购买1个月,不自动续费。
调用示例
GET https://dev.kdlapi.com/api/createorder?secret_id=o1fjh1re9o28876h7c08
&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=oxf0n0g59h7wcdyvz2uo68ph2s
购买海外动态代理包年包月
带宽7Mb/s,购买1个月,不自动续费。
调用示例
GET https://dev.kdlapi.com/api/createorder?secret_id=o1fjh1re9o28876h7c08
&product=FPS
&fps.serie=2
&pay_type=PRE_PAY
&prepay.time_type=MONTH
&prepay.time_number=1
&fps.bw=7
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
购买海外动态代理按流量付费
10GB流量。
调用示例
GET https://dev.kdlapi.com/api/createorder?secret_id=o1fjh1re9o28876h7c08
&product=FPS
&fps.serie=1
&pay_type=PRE_PAY
&prepay.time_type=MONTH
&prepay.time_number=1
&fps.flow=10
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
购买海外静态代理零售
美国10台,购买1个月
调用示例
GET https://dev.kdlapi.com/api/createorder?secret_id=o1fjh1re9o28876h7c08
&product=SFPS
&sfps.serie=1
&pay_type=PRE_PAY
&prepay.time_type=MONTH
&prepay.time_number=1
&sfps.areas_select=US:10
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
购买海外静态代理包段
中国香港50台,日本东京100台,购买1个月
调用示例
GET https://dev.kdlapi.com/api/createorder?secret_id=o1fjh1re9o28876h7c08
&product=SFPS
&sfps.serie=2
&pay_type=PRE_PAY
&prepay.time_type=MONTH
&prepay.time_number=1
&sfps.areas_select=CN-HK:50|JP-TYO:100
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
使用说明
点击查看关于API授权与验证的介绍
4. 返回结果
接口返回json格式,样例:
{
"msg": "create order success",
"code": 0,
"data": {
"orderid": "965102959536478"
}
}
携带is_coupon=1参数但无可用优惠券时返回格式,样例:
{
"msg": "create order success",
"code": 0,
"data": {
"orderid": "965102959536478",
"warning": "no available coupon"
}
}
异常返回格式样例:
{"code": -1, "msg": "缺少参数", "data": ""}
5. 错误码一览
错误码 | 说明 |
---|---|
-1 | 缺少参数 |
-2 | 参数值错误 |
-3 | API密钥类型错误,请使用账户API密钥 |
-4 | 账户余额不足 |
-5 | 开通订单类型错误 |
-61 | 暂无IP可供购买 |
-62 | kps.ip_count超过了可供购买的最大IP数量 |
-71 | 未满足开通隧道按量付费订单的条件 |
-72 | 开通隧道按量付费订单出现错误 |
6. SDK
快代理提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。