獲取代理鑒權信息
1. 接口描述
https://dev.kdlapi.com/api/getproxyauthorization 英文代號:get proxy authorization
獲取指定訂單訪問代理IP的鑒權信息。
鑒權信息包含用戶名密碼,用于請求私密代理/獨享代理/隧道代理/海外代理動態住宅/海外代理靜態住宅時進行身份驗證。
鑒權信息在HTTP請求的Header中傳遞,格式為:
Proxy-Authorization: <type> <credentials>
- 必須使用訂單API密鑰調用本接口
- 支持私密代理 / 隧道代理 / 獨享代理 / 海外代理動態住宅 / 海外代理靜態住宅訂單
- 接口最快調用頻率: 1秒10次
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) |
| plaintext | 否 | 是否明文返回用戶名密碼。值為1則會在返回的結果中包含username和password字段。 |
默認值:0 |
3. 調用示例
在會員中心API密鑰管理頁得到訂單的SecretId和SecretKey:
- SecretId:
o1fjh1re9o28876h7c08 - SecretKey:
jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
以密鑰令牌驗證為例,調用獲取密鑰令牌接口得到密鑰令牌:
- SecretToken:
oxf0n0g59h7wcdyvz2uo68ph2s
調用示例
GET https://dev.kdlapi.com/api/getproxyauthorization?secret_id=o1fjh1re9o28876h7c08
&signature=oxf0n0g59h7wcdyvz2uo68ph2s&plaintext=1
使用說明
點擊查看關于API授權與驗證的介紹
4. 返回結果
接口返回json格式,樣例:
{
"msg": "",
"code": 0,
"data": {
"type": "Basic",
"credentials": "eGlhb3EpYW5nOnMyZWYhZDM=",
"username": "xiaoqiang",
"password": "s2efad3"
}
}
字段說明如下:
| 參數 | 說明 |
|---|---|
| code | 返回碼。取值:0代表成功 非0代表失敗 |
| msg | 錯誤信息 |
| data.type | 身份驗證類型,固定為Basic |
| data.credentials | 鑒權信息。構成方式如下: 將用戶名和密碼用冒號拼接(aladdin:opensesame)。 將拼接生成的字符串使用 base64 編碼方式進行編碼(YWxhZGRpbjpvcGVuc2VzYW1l)。 |
| data.username | 用戶名。plaintext=1時返回 |
| data.password | 密碼。plaintext=1時返回 |
5. 錯誤碼一覽
| 錯誤碼 | 說明 |
|---|---|
| -3 | 訂單類型錯誤,只支持私密代理、隧道代理、獨享代理、海外代理動態住宅、海外代理靜態住宅(除零售) |
6. SDK
快代理提供了配套的開發工具集(SDK),支持多種編程語言,能更方便的調用 API。