查詢海外靜態住宅可開通的地區
1. 接口描述
https://dev.kdlapi.com/api/querysfpsarea 英文代號:query sfps area
本接口用于查詢海外靜態住宅可開通的地區。
- 支持訂單或賬戶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) |
| serie | 是 | 付費模式 | 1:零售 2:包段 |
3. 調用示例
在會員中心API密鑰管理頁得到訂單的SecretId和SecretKey:
- SecretId:
o1fjh1re9o28876h7c08 - SecretKey:
jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
以密鑰令牌驗證為例,調用獲取密鑰令牌接口得到密鑰令牌:
- SecretToken:
oxf0n0g59h7wcdyvz2uo68ph2s
零售
調用示例
如下示例查詢海外靜態住宅零售可開通的地區:
GET https://dev.kdlapi.com/api/querykpscity?secret_id=o1fjh1re9o28876h7c08
&serie=1
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
包段
調用示例
如下示例查詢海外靜態住宅包段可開通的地區:
GET https://dev.kdlapi.com/api/querysfpsarea?secret_id=o1fjh1re9o28876h7c08
&serie=2
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
使用說明
點擊查看關于API授權與驗證的介紹
4. 返回結果
接口返回json格式,樣例:
{
"msg": "",
"code": 0,
"data": [
{
"code": "US",
"name": "美國"
},
{
"code": "JP",
"name": "日本"
},
{
"code": "PH",
"name": "菲律賓"
},
{
"code": "GB",
"name": "英國"
},
{
"code": "IN",
"name": "印度"
},
{
"code": "SG",
"name": "新加坡"
},
{
"code": "KR",
"name": "韓國"
}
]
}
異常返回格式樣例:
{"code": -1, "msg": "缺少參數", "data": ""}
5. 錯誤碼一覽
| 錯誤碼 | 說明 |
|---|---|
| -1 | 缺少參數 |
| -2 | 參數值錯誤 |
| -3 | 訂單類型錯誤 |
6. SDK
快代理提供了配套的開發工具集(SDK),支持多種編程語言,能更方便的調用 API。