創(chuàng)建訂單

1. 接口描述

https://dev.kdlapi.com/api/createorder 英文代號(hào)：create order

本接口用于創(chuàng)建訂單，自動(dòng)從賬戶余額里結(jié)算費(fèi)用。
一次調(diào)用限創(chuàng)建一個(gè)訂單，如需創(chuàng)建多個(gè)訂單請(qǐng)分多次調(diào)用本接口。

調(diào)用本接口前請(qǐng)?zhí)崆按_保賬戶余額充足
必須使用賬戶API密鑰調(diào)用本接口
接口最快調(diào)用頻率: 1秒1次

2. 參數(shù)說明

公共參數(shù)

參數(shù)	是否必填	參數(shù)說明	取值說明
secret_id	是	賬戶SecretId	查看賬戶API密鑰信息
sign_type	否	簽名驗(yàn)證方式。目前支持token和hmacsha1。	默認(rèn)值：token
signature	是	請(qǐng)求簽名，用來驗(yàn)證此次請(qǐng)求的合法性。	支持2種簽名驗(yàn)證方式，簽名計(jì)算方法參見API 授權(quán)與驗(yàn)證
timestamp	否	當(dāng)前 UNIX 時(shí)間戳（秒級(jí)），可記錄發(fā)起 API 請(qǐng)求的時(shí)間。 sign_type=hmacsha1時(shí)此參數(shù)有效且為必填項(xiàng)。	例如1557546010，如果與當(dāng)前時(shí)間相差過大，會(huì)引起簽名過期錯(cuò)誤。
nonce	否	隨機(jī)正整數(shù)，與 timestamp 聯(lián)合起來，用于防止重放攻擊。建議攜帶此參數(shù)進(jìn)一步提升API安全性。 sign_type=hmacsha1時(shí)此參數(shù)有效。	客戶自行生成隨機(jī)正整數(shù)，如random.randint(1, 100000000)
is_notify	否	訂單創(chuàng)建成功后是否發(fā)送通知。	1: 發(fā)送通知(默認(rèn)) 0: 不發(fā)通知
is_coupon	否	是否使用優(yōu)惠券。攜帶is_coupon=1參數(shù)會(huì)自動(dòng)選中最優(yōu)優(yōu)惠券進(jìn)行下單，沒有可用優(yōu)惠券時(shí)下單不受影響。活動(dòng)期間無法使用優(yōu)惠券	1: 使用 0: 不使用(默認(rèn))
product	是	開通的產(chǎn)品類型	TPS_PRO: 隧道代理Pro TPS: 隧道代理 DPS: 私密代理 KPS: 獨(dú)享代理 FPS: 海外動(dòng)態(tài)住宅 SFPS:海外靜態(tài)住宅
pay_type	是	付費(fèi)方式	PRE_PAY: 包年包月(預(yù)付費(fèi)) PRE_PAY_IP: 按IP付費(fèi)(預(yù)付費(fèi))僅支持私密代理 POST_PAY: 按量付費(fèi)(后付費(fèi))僅支持隧道代理

以下為開通包年包月(預(yù)付費(fèi))訂單時(shí)所需的參數(shù)

參數(shù)	是否必填	參數(shù)說明	取值說明
prepay.time_type	是	時(shí)長類型選擇	DAY: 包天 WEEK: 包周 MONTH: 包月 YEAR: 包年注：獨(dú)享代理IP獨(dú)享型、海外靜態(tài)代理只支持包月和包年
prepay.time_number	否	時(shí)長數(shù)量	取值范圍： ? 包天：1~5 ? 包周：1~3 ? 包月：1~9 ? 包年：1~3 默認(rèn)取值：1
prepay.is_auto_renew	否	是否開啟自動(dòng)續(xù)費(fèi) pay_type=PRE_PAY時(shí)此參數(shù)生效海外靜態(tài)代理不支持自動(dòng)續(xù)費(fèi)	0: 不開啟(默認(rèn)) 1: 開啟
prepay.auto_renew_unit	否	自動(dòng)續(xù)費(fèi)時(shí)長 prepay.is_auto_renew=1時(shí)此參數(shù)生效	DAY: 按天自動(dòng)續(xù)費(fèi) WEEK: 按周自動(dòng)續(xù)費(fèi) MONTH: 按月自動(dòng)續(xù)費(fèi)(默認(rèn)) YEAR: 按年自動(dòng)續(xù)費(fèi) 注：獨(dú)享代理IP獨(dú)享型只支持按月和按年自動(dòng)續(xù)費(fèi)

隧道代理Pro相關(guān)參數(shù)

參數(shù)	是否必填	參數(shù)說明	取值說明
tps.max_rps	是	并發(fā)請(qǐng)求數(shù)	取值范圍：5~1000 (默認(rèn)值: 5)

隧道代理相關(guān)參數(shù)

參數(shù)	是否必填	參數(shù)說明	取值說明
tps.period	是	換IP周期(秒)	有效取值： ? 0: 每次請(qǐng)求換IP ? 15: 15秒 ? 30: 30秒 ? 60: 1分鐘 ? 300：5分鐘 ? 600：10分鐘 ? 900：15分鐘 ? 1800：30分鐘 ? 3600：1小時(shí) ? 21600：6小時(shí) ? 43200：12小時(shí) ? 86400：24小時(shí)
tps.max_rps	否	并發(fā)請(qǐng)求數(shù)	取值范圍：5~1000次/s (默認(rèn)值: 5) 注：tps.period >= 60 默認(rèn)無限并發(fā)
tps.max_bandwidth	否	帶寬規(guī)格	0 <=tps.period <= 1800，取值范圍：3~300Mb/s (默認(rèn)值: 3) tps.period = 3600，取值范圍：3~15 (默認(rèn)值: 3) tps.period >= 21600，取值固定為3 注：購買時(shí)長小于1個(gè)月僅支持200M以下帶寬
tps.ip_pool	否	IP資源池	1: 企業(yè)IP池（默認(rèn)） 2: 星辰IP池注：tps.period>=300時(shí) tps.ip_pool僅可為1

私密代理相關(guān)參數(shù)

參數(shù)

是否必填

參數(shù)說明

取值說明

dps.fetch_type

否

IP提取方式
pay_type=PRE_PAY時(shí)此參數(shù)生效
并且為必填項(xiàng)

1: 均勻提取
2: 集中提取
注：均勻提取和集中提取均屬于包年包月（預(yù)付費(fèi)）產(chǎn)品

dps.period

是

IP有效時(shí)長

均勻提取和集中提取有效取值：
? 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小時(shí)

均勻提取固定時(shí)長有效取值：
? M_1: 1分鐘
? M_2: 2分鐘
...
? M_30: 30分鐘
集中提取固定時(shí)長有效取值：
? M_1: 1分鐘
? M_2: 2分鐘
...
? M_30: 30分鐘

按IP付費(fèi)標(biāo)準(zhǔn)版有效取值：
? 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小時(shí)

按IP付費(fèi)專業(yè)版有效取值：
? M_1: 1分鐘
? M_2: 2分鐘
...
? M_30: 30分鐘

dps.ip_count

是

每天IP量(包年包月)
購買IP量(按IP付費(fèi))

取值范圍根據(jù)產(chǎn)品型號(hào)的不同而不同

均勻提取取值范圍：
? 1~5分鐘： 2000~600000 (2000的整數(shù)倍)
? 5~10分鐘： 1000~250000 (1000的整數(shù)倍)
? 10~20分鐘： 1000~100000 (1000的整數(shù)倍)
? 20~30分鐘： 1000~20000 (1000的整數(shù)倍)
? 30~60分鐘： 1000~5000 (1000的整數(shù)倍)
? 2~4小時(shí)： 100~1200 (100的整數(shù)倍)

集中提取取值范圍：
? 1~5分鐘： 1000~200000 (1000的整數(shù)倍)
? 5~10分鐘： 1000~50000 (1000的整數(shù)倍)
? 10~20分鐘： 1000~30000 (1000的整數(shù)倍)
? 20~30分鐘： 1000~25000 (1000的整數(shù)倍)
? 30~60分鐘： 1000~25000 (1000的整數(shù)倍)
? 2~4小時(shí)： 100~1200 (100的整數(shù)倍)

按IP付費(fèi)取值范圍：
? 1~5分鐘： 1000~100萬 (1000的整數(shù)倍)
? 5~10分鐘： 1000~100萬 (1000的整數(shù)倍)
? 10~20分鐘： 1000~100萬 (1000的整數(shù)倍)
? 20~30分鐘： 1000~100萬 (1000的整數(shù)倍)
? 30~60分鐘： 1000~100萬 (1000的整數(shù)倍)
? 2~4小時(shí)： 100~10萬 (100的整數(shù)倍)

獨(dú)享代理相關(guān)參數(shù)

參數(shù)	是否必填	參數(shù)說明	取值說明
kps.serie	是	獨(dú)享類型	1: IP共享型 2: IP獨(dú)享型
kps.model	否	型號(hào)選擇 kps.serie=1時(shí)此參數(shù)生效并且為必填項(xiàng)	DYN: 動(dòng)態(tài)型 STA: 靜態(tài)型
kps.city	否	城市選擇指定開通某個(gè)城市的IP kps.model=STA時(shí)此參數(shù)生效	取值為2~4位城市編碼(參見中國地區(qū)編碼表) 默認(rèn)取值：空串取值為空串或不帶此參數(shù)代表隨機(jī)分配城市可通過查詢接口得知有哪些城市可供開通以及每個(gè)城市可開通的IP數(shù)量
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

海外動(dòng)態(tài)代理相關(guān)參數(shù)

參數(shù)	是否必填	參數(shù)說明	取值說明
fps.serie	是	付費(fèi)模式	1:流量付費(fèi) 2:包年包月
fps.flow	否	流量選擇 fps.serie=1時(shí)此參數(shù)生效并且為必填項(xiàng)	有效取值： ? 1：1GB ? 6：6GB ? 10：10GB ? 35：35GB ? 110：110GB ? 200：200GB ? 500：500GB ? 1000：1000GB
fps.bw	否	帶寬選擇 fps.serie=2時(shí)此參數(shù)生效并且為必填項(xiàng)	取值為5~50Mb/s（默認(rèn)值：5）

海外靜態(tài)代理相關(guān)參數(shù)

參數(shù)	是否必填	參數(shù)說明	取值說明
sfps.serie	是	付費(fèi)模式	1: 零售 2: 包段
sfps.areas_select	是	指定地區(qū)和數(shù)量。	取值為`地區(qū)編碼:數(shù)量` 多個(gè)地區(qū)使用 \| 隔開,如 US:1、US:1\|JP:3 sfps.serie= 2 時(shí)可購買數(shù)量為50的倍數(shù) 單次開通的最大IP數(shù)量為2000 地區(qū)編碼通過（查詢接口）獲得

3. 調(diào)用示例

在會(huì)員中心API密鑰管理頁得到賬戶的SecretId和SecretKey：

SecretId：o1fjh1re9o28876h7c08
SecretKey：jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

以密鑰令牌驗(yàn)證為例，調(diào)用獲取密鑰令牌接口得到密鑰令牌：

SecretToken：oxf0n0g59h7wcdyvz2uo68ph2s

購買隧道包年包月

每次換IP周期為1分鐘的隧道，并發(fā)請(qǐng)求數(shù)為10次/s，帶寬3Mb/s，購買1個(gè)月，不自動(dòng)續(xù)費(fèi)。

調(diào)用示例

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包年包月

并發(fā)請(qǐng)求數(shù)為10次/s，購買1個(gè)月，不自動(dòng)續(xù)費(fèi)。

調(diào)用示例

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

購買隧道按量付費(fèi)

開通每次請(qǐng)求更換IP的隧道，并發(fā)請(qǐng)求數(shù)為100次/s，帶寬10Mb/s。

調(diào)用示例

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周，按周自動(dòng)續(xù)費(fèi)。

調(diào)用示例

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付費(fèi)標(biāo)準(zhǔn)版

買10萬個(gè)可用時(shí)長1~5分鐘的IP。

調(diào)用示例

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付費(fèi)專業(yè)版

買10萬個(gè)可用時(shí)長3分鐘的IP。

調(diào)用示例

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共享型獨(dú)享代理

1個(gè)鄭州市的標(biāo)準(zhǔn)型IP，購買1個(gè)月，按月自動(dòng)續(xù)費(fèi)。

調(diào)用示例

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獨(dú)享型獨(dú)享代理

1個(gè)帶寬4M的IP，城市隨機(jī)分配，購買1個(gè)月，不自動(dòng)續(xù)費(fèi)。

調(diào)用示例

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

購買海外動(dòng)態(tài)代理包年包月

帶寬7Mb/s，購買1個(gè)月，不自動(dòng)續(xù)費(fèi)。

調(diào)用示例

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

購買海外動(dòng)態(tài)代理按流量付費(fèi)

10GB流量。

調(diào)用示例

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

購買海外靜態(tài)代理零售

美國10臺(tái)，購買1個(gè)月

調(diào)用示例

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

購買海外靜態(tài)代理包段

中國香港50臺(tái)，日本東京100臺(tái)，購買1個(gè)月

調(diào)用示例

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

使用說明

點(diǎn)擊查看關(guān)于API授權(quán)與驗(yàn)證的介紹

4. 返回結(jié)果

接口返回json格式，樣例：

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

攜帶is_coupon=1參數(shù)但無可用優(yōu)惠券時(shí)返回格式，樣例：

{
  "msg": "create order success",
  "code": 0,
  "data": {
    "orderid": "965102959536478",
    "warning": "no available coupon"
  }
}

異常返回格式樣例：

{"code": -1, "msg": "缺少參數(shù)", "data": ""}

5. 錯(cuò)誤碼一覽

錯(cuò)誤碼	說明
-1	缺少參數(shù)
-2	參數(shù)值錯(cuò)誤
-3	API密鑰類型錯(cuò)誤，請(qǐng)使用賬戶API密鑰
-4	賬戶余額不足
-5	開通訂單類型錯(cuò)誤
-61	暫無IP可供購買
-62	kps.ip_count超過了可供購買的最大IP數(shù)量
-71	未滿足開通隧道按量付費(fèi)訂單的條件
-72	開通隧道按量付費(fèi)訂單出現(xiàn)錯(cuò)誤

6. SDK

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

SDK下載