企业地址解析接口
输入企业地址/监管机构名称,返回所属省、地市、区县
请求方式
- 请求地址:
http://api.shuidi.cn/ic/addressParse
- 请求方式:
GET/POST
- 支持格式:
JSON
- 请求示例:
http://api.shuidi.cn/ic/addressParse?pname=patest&ptime=1571990576623&vkey=2237ae09ea514c43a37ab0c57968f536&key=郑州市金水区市场监督管理局
接口认证
客户每次调用接口,必需包含接入ID(pname), 安全验证码(vkey)和时间戳(ptime).
参数名称 | 类型 | 是否必填 | 说明 | 示例值 |
---|---|---|---|---|
pname | String | 是 | 调用方唯一ID,用于身份识别 | patest |
ptime | String | 是 | 时间戳,从格林威治时间1970年01月01日00时00分00秒起至现在的时间,精确到毫秒(13位) | 1571990576623 |
vkey | String | 是 | 安全验证码。使用下划线依次连接pkey、ptime、pkey,计算该字符串的MD5值完成签名. 结果为32个字符 |
2237ae09ea514c43a37ab0c57968f536 |
Java计算vkey示例:
String ptime =String.valueOf(System.currentTimeMillis());
SecureUtil.md5(pkey + "_" + ptime + "_" + pkey);
php计算vkey示例:
$vkey=md5($pkey.”_”.$ptime.”_”.$pkey)
请求参数
参数名称 | 类型 | 是否必填 | 说明 | 示例 |
---|---|---|---|---|
key | String | 是 | 地址/管理机关名称 | 郑州市金水区市场监督管理局 |
响应结果
返回数据格式
所有接口返回值以JSON字符串的形式返回给调用者,JSON格式如下:
{ "statusCode": 1, "statusMessage": "请求成功", "data": {} }
返回JSON属性如下:
属性 | 说明 |
---|---|
statusCode | 返回查询结果编码 |
statusMessage | statusCode不为1时的错误信息描述。 |
data | 结果数据。不同接口,data的内容会有所不同。具体见各接口返回说明。 |
响应示例
{
"statusCode": 1,
"statusMessage": "请求成功",
"data": {
"province": "河南省",
"city": "郑州市",
"district_code": "410105",
"district": "金水区",
"city_code": "410100",
"province_code": "410000"
}
}
输出结果字段含义
属性名 | 类型 | 含义 |
---|---|---|
province | String | 省份 |
provinceCode | String | 行政区号 |
city | String | 地市 |
cityCode | String | 行政区号 |
district | String | 区县 |
districtCode | String | 行政区号 |
错误编码
错误编码 | 说明 |
---|---|
1 | 请求成功 |
2 | 未查询到数据 |
3 | 接口未授权 |
4 | 请求参数错误 |
30001 | 请求已过期 |
99999 | 系统错误 |