更多资料请参考:www.woyaocha.net/product/area
接口描述
功能描述
根据行政区划代码获取行政区划名称,或者根据行政区划名称获取行政区划代码。
URL 示例
1)http
协议:
POST 方式请求:
Copy
http://cha.ebaitian.cn/api/json?appid=xxx&module=getAreaInfo&area=xxx&sign=xxx
GET 方式请求:
Copy
http://cha.ebaitian.cn/api/json?type=get&appid=xxx&module=getAreaInfo&area=xxx&sign=xxx
2)https
协议:
POST 方式请求:
Copy
https://cha.ebaitian.cn/api/json?appid=xxx&module=getAreaInfo&area=xxx&sign=xxx
GET 方式请求:
Copy
https://cha.ebaitian.cn/api/json?type=get&appid=xxx&module=getAreaInfo&area=xxx&sign=xxx
请求参数
数据包体
Copy
{
"type": "get",
"appid": "1000xxxx",
"module": "getAreaInfo",
"area": "东西湖",
"sign": "ecab4881ee80ad3d76bb1da68387428ca752eb885e52621a3129dcf4d9bc4fd4"
}
参数说明
参数 | 必选 | 类型 | 描述 |
---|---|---|---|
type | 否 | string | 授权接口的请求方式 |
appid | 是 | string | 授权接口的 AppID,请填写您在我要查官网上申请到的 AppID |
module | 是 | string | 目标请求的数据模块,查询行政区划代码为:getAreaInfo |
area | 是 | string | 目标要查询的行政区划代码或名称,也可以是对应的行政区划代码(6位),如:110000 |
sign | 是 | string | 请求凭证,具体计算方式见下面的其他说明 |
其他说明
1)type:可选值 get,如果赋值 get,则以 get 方式提交数据;默认以 post 方式提交数据;
2)sign:签名校验,根据公式 $sign=sha256(appid=$appid&module=getAreaInfo&area=$area&appkey=$appkey)
生成;其中:appkey 为授权接口的 AppKey,请填写您在我要查官网上申请到的 AppKey 。
构造伪代码如下:
Copy
string type = "get"; //请求方式,可以赋值为:post
string appid = "1000xxxx"; //sdkappid 对应的 appid,需要业务方高度保密
string module = "getAreaInfo"; //请求的数据模块,此处赋值:getMobileArea
string area = "东西湖"; //要查询的行政区划代码或名称,也可以是对应的行政区划代码(6位),如:420112
string sign = sha256(appid=1000xxxx&module=getAreaInfo&area=北京&appkey=56cf61af4b7897e704f67deb88ae8f24);
响应参数
数据包体
Copy
{
"result":1,
"description":"TRUE",
"flag":"",
"areaInfo":{
"areacode":"420112",
"areaname":"东西湖区",
"province":"湖北省",
"city":"武汉市",
"note":null
}
}
参数说明
参数 | 必选 | 类型 | 描述 |
---|---|---|---|
result | 是 | string | 接口响应结果:0-失败;1-成功 |
description | 是 | string | 接口响应描述:一般为 TURE(result=1) 与 FALSE(result=0),或者返回错误信息 |
flag | 否 | string | 错误说明,没有错误则返回空 |
areaInfo | 是 | object | 返回行政区划代码信息 |
areaInfo 参数说明:
参数 | 必选 | 类型 | 描述 |
---|