获取海外代理动态住宅地区编码
1. 接口描述
https://dev.kdlapi.com/api/getfpsareacode 英文代号:get fps area code
- 支持订单或账户API密钥调用本接口
- 接口最快调用频率:1秒1次
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) |
region | 是 | 国家编码 | 国家编码,例如:US,IN |
3. 调用示例
在会员中心API密钥管理页得到订单的SecretId和SecretKey:
- SecretId:
o1fjh1re9o28876h7c08
- SecretKey:
jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
以密钥令牌验证为例,调用获取密钥令牌接口得到密钥令牌:
- SecretToken:
oxf0n0g59h7wcdyvz2uo68ph2s
调用示例
获取美国的州编码
GET https://dev.kdlapi.com/api/getfpsareacode?secret_id=o1fjh1re9o28876h7c08
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
®ion=US
使用说明
点击查看关于API授权与验证的介绍
4. 返回结果
接口返回json格式,样例:
{
"msg": "",
"code": 0,
"data": [
"Arizona", "Utah", "Virginia", "Minnesota", "North Carolina", "Ohio", "Wisconsin", "Kansas",
"South Carolina", "Nebraska", "Indiana", "Washington", "Hawaii", "Montana", "Idaho", "West Virginia",
"New Hampshire", "Oregon", "Colorado", "Alabama", "Connecticut", "New York", "Delaware", "Maryland",
"Texas", "California", "Georgia", "Florida", "Massachusetts", "Arkansas", "New Mexico", "New Jersey",
"Pennsylvania", "Nevada", "North Dakota", "Tennessee", "Kentucky", "Mississippi", "Illinois", "Missouri",
"Oklahoma", "Michigan", "Vermont", "Wyoming", "Rhode Island", "Louisiana", "Maine", "District of Columbia",
"Iowa", "Alaska", "South Dakota"
]
}
异常返回格式样例:
{"code": -1, "msg": "参数错误", "data": ""}
输入的国家查询不到编码时返回:
{ "msg": "", "code": 0, "data": [] }
5. 错误码一览
错误码 | 说明 |
---|---|
-1 | 缺少参数 |
6. SDK
快代理提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。