一、快递可用性接口
通过收寄件地址判断该线路是否可寄送，返回内容包括寄件地址可达性，收件地址可达性，以及可提供寄件服务的快递公司。
1.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
1.2 请求地址
http://api.kuaidi100.com/reachable.do
1.3 请求参数
请求参数（header）
| 名称 | 类型 | 默认值 |
|---|---|---|
| Content-Type | string | application/x-www-form-urlencoded |
请求参数（body）
| 参数名称 | 数据类型 | 是否必填 | 参数描述 |
|---|---|---|---|
| method | string | 是 | 业务类型（默认：reachable） |
| key | string | 是 | 授权码，请申请企业版获取 |
| sign | 是 | string | 32位大写，签名，用于验证身份，按MD5 (param +t+key+ secret)的顺序进行MD5加密，不需要加上“+”号，secret可在企业管理后台中企业信息查看 |
| t | 是 | string | 时间戳如：1576123932000 |
| param | 是 | param | 由其他字段拼接 |
param数据结构
| 参数名称 | 数据类型 | 是否必填 | 参数描述 |
|---|---|---|---|
| recManName | string | 是 | 收件人姓名 |
| recManMobile | string | 是 | 收件人的手机号 |
| recManPrintAddr | string | 是 | 收件人所在完整地址（至少到四级地址，即省-市-区-街道），如广东深圳市深圳市南山区粤海街道科技南十二路2号金蝶软件园 |
| sendManName | string | 是 | 寄件人姓名 |
| sendManMobile | string | 是 | 寄件人的手机号 |
| sendManPrintAddr | string | 是 | 寄件人所在完整地址（至少到四级地址，即省-市-区-街道），如广东深圳市深圳市南山区粤海街道科技南十二路2号金蝶软件园 |
| kuaidicom | string | 是 | 快递公司编码，如yuantong，shunfeng，一次仅支持传入一家快递公司，支持的快递公司及编码见本文档1.8 支持快递公司列表 |
1.4 请求参数示例
{
"recManPrintAddr": "浙江省湖州市吴兴区织****",
"sendManPrintAddr": "福建省宁德市霞***",
"recManMobile": "****",
"sendManName": "****",
"recManName": "***",
"kuaidicom": "yuantong",
"sendManMobile ": "*****"
}
1.5 返回结果
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| result | boolean | 提交结果 | true提交成功，false失败 |
| returnCode | string | 返回编码 | |
| message | string | 返回报文描述 | |
| data | Object |
data数据结构
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| taskId | string | 任务ID | |
| toReachable | string | 地址可达性校验 |
toReachable数据结构
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| expressCode | string | 快递公司编码 | |
| reachable | string | 是否可达，0：不可达，1：可达 | |
| reason | string | 不可达的原因 |
1.6 返回参数示例
{
"message": "成功",
"returnCode": "200",
"result": true,
"data": {
"taskId": "E9E0AA920791542C8D491968DC5601E3",
"toReachable": [{
"reachable": 1,
"expressCode": "yuantong"
}]
}
}
1.7 信息代码含义
| 信息代码 | 信息内容描述 | 原因及建议处理方式 | |
|---|---|---|---|
| 200 | 成功 | 成功 | |
| 201 | 参数异常 | 检查地址行政区相关参数 | |
| 400 | 行政区解析失败 | 检查地址中行政区域信息是否正确、完整 | |
| 503 | 验证签名失败 | 检查加密方式，param +t+key+ secret的顺序进行MD5加密，加密后字符串转32位大写,不用加上“+”号 | |
| 601 | key已过期 | 没有可用单量，账号不存在或者没有该接口权限 | |
| 600 | 您不是合法的用户 | 授权key出错或账户无可用单量 |
二、支持快递公司列表
| 快递公司名称 | 编码 |
|---|---|
| 圆通 | yuantong |
| 顺丰速运 | shunfeng |
| 京东快递 | jd |
| 中通快递 | zhongtong |
| 中通快运 | zhongtongkuaiyun |
| 申通快递 | shentong |
| 韵达快递 | yunda |
| EMS | ems |
| 极兔速递 | jtexpress |
| 德邦快递 | debangkuaidi |
| 邮政快递包裹 | youzhengguonei |
| 安能物流 | annengwuliu |
