获取指定地区编码

1. 接口描述

https://dev.kdlapi.com/api/getareacode 英文代号:get area code

获取指定地区的编码。
地区编码参照中国地区编码表

  1. HTTP GET接口
  2. 参数和返回内容均采用utf-8编码
  3. 接口最快调用频率:1秒10次

2. 参数说明

参数 是否必填 参数说明 取值说明
orderid 订单号 有效订单号或虚拟订单号
推荐使用虚拟订单号。
sign_type 签名验证方式。目前支持simple和hmacsha1。 默认值:simple
signature 请求签名,用来验证此次请求的合法性。 支持2种签名验证方式,签名计算方法参见API 授权与验证
timestamp 当前 UNIX 时间戳(秒级),可记录发起 API 请求的时间。
sign_type=hmacsha1时此参数为必填项。
例如1557546010,如果与当前时间相差过大,会引起签名过期错误。
area 地区名称,支持省和市 省和市的中文名称,例如:北京市、江苏省

3. 调用示例

在会员中心订单API接口页面得到虚拟订单和API Key。

  • 虚拟订单号:399141692192336
  • apikey:jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

为演示简单,这里采用密钥明文验证生成签名参数,建议您在生产环境采用数字签名验证。

调用示例

获取广州市的地区编码

GET https://dev.kdlapi.com/api/getareacode?orderid=399141692192336
&area=广州市
&signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

4. 返回结果

接口返回json格式,样例:

{
  "msg": "",
  "code": 0,
  "data": {
    "are_name": "北京市",
    "are_code": "11"
  }
}

异常返回格式样例:

{"code": -1, "msg": "参数错误", "data": ""}

输入的地区查询不到编码时返回:
{ "msg": "", "code": 0, "data": { "are_name": "", "are_code": "" } }

5. 错误码一览

错误码 说明
-1 缺少参数
-10 接口调用频率超出限制

6. SDK

快代理提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

SDK下载

联系我们
  • 售前在线咨询
    咨询享免费测试,专业工程师提供技术支持
  • 客服热线
    400-058-0638  周一至周六 9:00-18:30
  • 提交工单
    您的每一次反馈我们都认真对待
  • 客服微信 & QQ
    客服微信:kuaidaili,客服QQ:800849628
  • 企业客户通道
    提交需求后专业的售前工程师为您提供服务