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