获取代理鉴权信息
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。