一、智能地址解析接口
该接口提供智能识别姓名、电话、地址的功能,并解析地址返回对应信息。
1.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
1.2 请求地址
https://api.kuaidi100.com/address/resolution
请求参数(header):
参数名 | 类型 | 默认值 |
---|---|---|
Content-Type | string | application/x-www-form-urlencoded |
请求参数(body):
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
key | 是 | string | 授权码,请申请企业版获取 |
sign | 是 | string | 32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号secret在企业管理后台查看 |
t | 是 | string | 时间戳如:1576123932000 |
param | 是 | param | 由其他字段拼接 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
content | 否 | string | 需要解析的内容,例如:张三广东省深圳市南山区粤海街道科技南十二路金蝶软件园13088888888 |
image | 否 | string | 图片base64编码,最大限制4M |
imageUrl | 否 | string | 图片url,通过该url下载后得到的文件文件类型应当是图片,最大限制4M |
pdfUrl | 否 | string | pdf url,通过该url下载后得到的文件文件类型应当是pdf,最大限制4M |
htmlUrl | 否 | string | html url,通过该url下载后得到的文件文件类型应当是html,最大限制4M |
注意:接口超时为5秒。content、image、imageUrl、pdfUrl、htmlUrl必填其一,优先顺序:content>image>imageUrl>pdfUrl>htmlUrl。
1.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
success | boolean | 提交结果 | true提交成功,false失败 |
code | string | 返回编码 | |
message | string | 返回报文描述 | |
time | string | 时间 | 可忽略 |
data | Object | 相应数据 |
data数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
taskId | string | 任务ID | |
result | list | 解析结果列表 |
result 中数据项的数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
content | string | 入参的解析内容 | |
mobile | list | 手机号码列表 | 列表中的手机号码为字符串格式 |
name | string | 姓名 | |
address | string | 详细地址 | |
xzq | object | 行政区信息 |
xzq中数据项的数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
fullName | string | 完整地址 | 本字段将返回省市区全称,例如:广东省,深圳市,南山区 |
province | string | 省份名称 | 本字段将返回省份简称,例如:广东 |
city | string | 城市名称 | 本字段返回市级行政区简称,例如:深圳市 |
district | string | 区县名称 | 本字段返回区县简称,例如:南山区 |
subArea | string | 详细地址 | |
parentCode | string | 行政区父节点编码 | |
code | string | 行政区编码 | |
level | int | 行政区级别 |
1.4 请求参数示例
示例1
key = kytRstexx
sign = 4BBDE07660E5EFF90873642CFAE9A8DD
t = 1470304729724
param = {
"content": "张三广东省深圳市南山区粤海街道科技南十二路金蝶软件园13088888888"
}
示例2
key = kytRstexx
sign = 4BBDE07660E5EFF90873642CFAE9A8DD
t = 1470304729724
param = {
"imageUrl": "https://api.kuaidi100.com/getImage/123456789"
}
1.5 返回结果示例
成功示例:
{
"code": 200,
"data": {
"taskId": "0333CB76E70442A0BD275F5541549C30",
"result": [
{
"content": "张三广东省深圳市南山区粤海街道科技南十二路金蝶软件园 13088888888",
"mobile": [
"13088888888"
],
"name": "张三",
"address": "粤海街道科技南十二路金蝶软件园",
"xzq": {
"fullName": "广东省,深圳市,南山区",
"province": "广东",
"city": "深圳市",
"district": "南山区",
"subArea": "粤海街道科技南十二路金蝶软件园",
"parentCode": "440300",
"code": "440305",
"level": 3
}
}
]
},
"message": "success",
"time": 0,
"success": true
}
错误示例:
{
"code":10002,
"message":" 请求参数不能为空: content",
"time":0,
"success":false
}
1.6 返回信息代码含义:
信息代码 | 信息内容描述 | 原因及建议处理方式 |
---|---|---|
-1 | 解析失败/异常,请稍后重试 | 快递100的服务器出现间歇或临时性异常,解析超时,也会报此错误 |
200 | 提交成功 | 提交成功 |
10000 | 解析失败 | 解析失败,请检查入参内容是否正确 |
10002 | 请求参数错误 | 检查参数传参是否正确 |
10007 | 系统内部调用异常 | 系统内部调用异常,文件识别结果为空、识别失败、解析失败,请联系管理员处理 |
10025 | 非法请求,异常文件 | 接口请求下载文件识别报错会报此错误,请检查文件(url中的文件)是否完整、格式是否正确, |
30002 | 验证签名失败 | 检查加密方式,param +t+key+ secret的顺序进行MD5加密,加密后字符串转32位大写,不用加上“+”号 |
30004 | 账号单量不足需要充值 | 账号单量不足需要充值 |