API 接口概覽
1. 接口簡(jiǎn)介
快代理提供了功能豐富的API接口，滿足開(kāi)發(fā)者在各種場(chǎng)景下的調(diào)用需求。
目前已在5種語(yǔ)言的SDK中集成了API調(diào)用（查看），歡迎使用。
2. 接口說(shuō)明
2.1 通信協(xié)議
快代理API的所有接口均通過(guò) HTTPS 進(jìn)行通信，保證通信的高安全性。
2.2 請(qǐng)求方法
同時(shí)支持HTTP GET / POST，推薦使用POST請(qǐng)求。
POST 請(qǐng)求支持的 Content-Type: application/x-www-form-urlencoded
2.3 字符編碼
均采用UTF-8編碼
3. API 列表
4. 快速入門
4.1 生成API鏈接
以獲取私密代理IP接口為例，一個(gè)典型的API鏈接如下：
https://dps.kdlapi.com/api/getdps/?
secret_id=o1fjh1re9o28876h7c08&signature=oxf0n0g59h7wcdyvz2uo68ph2s&num=100&pt=1&sep=1
API鏈接各部分詳解
| 各部分 | 名稱 | 詳解 |
|---|---|---|
| https | 請(qǐng)求使用的協(xié)議 | 調(diào)用快代理API接口時(shí)，需要使用HTTPS協(xié)議 |
| dps.kdlapi.com | API域名 | |
| getdps | API接口名稱 | 查看所有API接口 |
| secret_id=o1fjh1re9o28876h7c08 | API密鑰信息 | 屬于公共參數(shù)，所有接口必須攜帶此參數(shù)，訂單相關(guān)的接口使用對(duì)應(yīng)的訂單SecretId，訂單號(hào)無(wú)關(guān)的接口(如賬號(hào)相關(guān)接口和工具接口)使用賬戶SecretId，查看API密鑰信息 |
| signature=oxf0n0g59h7wcdyvz2uo68ph2s | 簽名參數(shù) | 屬于公共參數(shù)，其接口必須攜帶簽名參數(shù)，以保障接口調(diào)用的安全性 |
| num=100 | 接口相關(guān)參數(shù) | 每個(gè)接口有自己特定的參數(shù)，具體請(qǐng)參見(jiàn)各接口文檔 |
對(duì)于3個(gè)代理提取API，您可以在線生成API鏈接，內(nèi)置到您的程序中：
其他接口請(qǐng)查看API文檔，獲取接口url和參數(shù)說(shuō)明，自己生成API鏈接。
4.2 測(cè)試API鏈接
瀏覽器測(cè)試
您可以把生成的API鏈接直接在瀏覽器里打開(kāi)，查看返回結(jié)果。例如，您直接點(diǎn)擊如下api鏈接
命令行測(cè)試
如果您在linux系統(tǒng)下，可以通過(guò)curl命令請(qǐng)求API鏈接查看結(jié)果：
curl "https://dps.kdlapi.com/api/getdps/?secret_id=o1fjh1re9o28876h7c08&signature=oxf0n0g59h7wcdyvz2uo68ph2s&num=100&pt=1&sep=1"
如何測(cè)試POST接口
您可以通過(guò)curl -d發(fā)起POST請(qǐng)求：
curl -d "param1=value1¶m2=value2" "https://dev.kdlapi.com/api/apiname"
4.3 錯(cuò)誤碼
每個(gè)接口自己的錯(cuò)誤碼請(qǐng)參見(jiàn)各接口文檔。
4.4 代碼樣例
查看API調(diào)用的代碼樣例
4.5 SDK下載
我們針對(duì)5種語(yǔ)言提供了api-sdk，您可以通過(guò)sdk簡(jiǎn)單快速地調(diào)用API。
其他語(yǔ)言后續(xù)也會(huì)陸續(xù)支持，敬請(qǐng)期待。
4.6 API調(diào)用統(tǒng)計(jì)
我們?cè)跁?huì)員中心提供了統(tǒng)計(jì)圖，方便您查看實(shí)時(shí)API調(diào)用數(shù)據(jù)。查看API調(diào)用統(tǒng)計(jì)
4.7 API設(shè)置與授權(quán)
API設(shè)置
快代理為對(duì)安全性有高要求的用戶提供了API調(diào)用驗(yàn)證設(shè)置，用戶可在會(huì)員中心-API接口-API設(shè)置中根據(jù)實(shí)際情況進(jìn)行設(shè)置。
1. 密鑰明文驗(yàn)證：默認(rèn)開(kāi)啟，但安全風(fēng)險(xiǎn)高，對(duì)安全性有要求的客戶可手動(dòng)關(guān)閉。
2. 密鑰令牌驗(yàn)證：默認(rèn)長(zhǎng)期開(kāi)啟，僅針對(duì)使用密鑰令牌驗(yàn)證方式。有效期最短10分鐘，最長(zhǎng)24小時(shí)，可根據(jù)自身需求進(jìn)行設(shè)置。
3. API調(diào)用授權(quán)：開(kāi)啟后，不在白名單中的IP將無(wú)法調(diào)用所有接口。
安全提示
密鑰明文驗(yàn)證安全性極低，密鑰泄露風(fēng)險(xiǎn)極高。非特殊場(chǎng)景建議關(guān)閉，開(kāi)啟后因密鑰泄露導(dǎo)致訂單資產(chǎn)損失快代理不承擔(dān)責(zé)任。
重要提示
企業(yè)賬號(hào)開(kāi)啟“密鑰明文驗(yàn)證”、“API調(diào)用授權(quán)”后，其對(duì)應(yīng)的子賬號(hào)在調(diào)用API時(shí)也會(huì)受到影響。
API授權(quán)
企業(yè)賬號(hào)可以在會(huì)員中心-賬戶管理-子賬號(hào)管理中為子賬號(hào)授權(quán)可調(diào)用的API接口。
