文档中心
一、智能地址解析接口 API调试工具

一、智能地址解析接口

该接口提供智能识别姓名、电话、地址的功能,并解析地址返回对应信息。

1.1 接口格式

提供统一格式的HTTP POST调用接口,并返回统一格式JSON数据。

1.2 请求地址

https://api.kuaidi100.com/address/resolution

请求参数(header):

参数名类型默认值
Content-Typestringapplication/x-www-form-urlencoded

请求参数(body):

参数名是否必填类型说明
keystring授权码,请申请企业版获取
signstring32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号secret在企业管理后台查看
tstring时间戳如:1576123932000
paramparam由其他字段拼接

param数据结构:

参数名是否必填类型说明
contentstring需要解析的内容,例如:张三广东省深圳市南山区粤海街道科技南十二路金蝶软件园13088888888
imagestring图片base64编码,最大限制4M
imageUrlstring图片url,通过该url下载后得到的文件文件类型应当是图片,最大限制4M
pdfUrlstringpdf url,通过该url下载后得到的文件文件类型应当是pdf,最大限制4M
htmlUrlstringhtml url,通过该url下载后得到的文件文件类型应当是html,最大限制4M

注意:接口超时为5秒。content、image、imageUrl、pdfUrl、htmlUrl必填其一,优先顺序:content>image>imageUrl>pdfUrl>htmlUrl。

1.3 返回结果

字段类型说明备注
successboolean提交结果true提交成功,false失败
codestring返回编码
messagestring返回报文描述
timestring时间可忽略
dataObject相应数据

data数据结构

字段类型说明备注
taskIdstring任务ID
resultlist解析结果列表

result 中数据项的数据结构

字段类型说明备注
contentstring入参的解析内容
mobilelist手机号码列表列表中的手机号码为字符串格式
namestring姓名
addressstring详细地址
xzqobject行政区信息

xzq中数据项的数据结构

字段类型说明备注
fullNamestring完整地址本字段将返回省市区全称,例如:广东省,深圳市,南山区
provincestring省份名称本字段将返回省份简称,例如:广东
citystring城市名称本字段返回市级行政区简称,例如:深圳市
districtstring区县名称本字段返回区县简称,例如:南山区
subAreastring详细地址
parentCodestring行政区父节点编码
codestring行政区编码
levelint行政区级别

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账号单量不足需要充值账号单量不足需要充值