首页 > API文档 > 单号识别API
单号识别API为用户提供单号识别快递公司服务,依托于快递鸟大数据平台,用户提供快递单号,即可实时返回可能的一个或多个快递公司,存在多个快递公司结果的,大数据平台根据可能性、单号量,进行智能排序。
(1)PC端、移动端应用或网站应用集成运单物流信息查询功能时,只需要录入单号即可完成查询,无需用户输入快递公司。
(2)电商网站要在快递鸟查询或者订阅运单时,可通过单号识别先行判断物流公司后,再订阅到快递鸟。
一、接口描述/说明
(1)该接口仅对运单号做出识别,识别可能属于的一家或多家快递公司。
(2)接口并不返回物流轨迹,用户可结合即时查询接口和订阅查询接口完成轨迹查询、订阅的动作。
(3)接口识别会返回一家或者多家快递公司,返回的数据根据快递鸟大数据分析结果排序,排名靠前的命中率更高。
(4)若识别失败,快递鸟返回的匹配结果为空。
(5)接口支持的消息接收方式为HTTP POST,请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
(6)接口地址:
API测试地址:http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址:https://api.kdniao.com/Ebusiness/EbusinessOrderHandle.aspx
请求系统级参数说明:
参数名称 | 类型 | 说明 | 必须要求 |
---|
RequestData | String | 请求内容需进行URL(utf-8)编码。请求内容JSON格式,须和DataType一致。 | 是 |
EBusinessID | String | 商户ID,请在我的服务页面查看。 | 是 |
RequestType | String | 请求指令类型:2002 | 是 |
DataSign | String | 数据内容签名:把(请求内容(未编码)+AppKey)进行MD5加密,然后Base64编码,最后
进行URL(utf-8)编码。详细过程请查看Demo。 | 是 |
DataType | String | 请求、返回数据类型:只支持JSON格式 | 是 |
二、接口参数
请求内容字段定义:
参数名称 | 类型 | 说明 | 是否必须 |
---|
LogisticCode | String | 物流单号 | 是 |
返回参数定义:
参数名称 | 类型 | 说明 | 必须要求 |
---|
EBusinessID | String | 电商用户ID | 是 |
LogisticCode | String | 物流单号 | 是 |
Success | Bool | 成功与否 | 是 |
Code | Int | 失败原因 | 否 |
Shipper | ShipperCode | String | 快递公司编码 | 否 |
ShipperName | String | 快递公司名称 | 否 |
三、示例
{
"LogisticCode": "3967950525457"
}
{
"EBusinessID": "1257021",
"Success": true,
"LogisticCode": "3967950525457",
"Shippers": [
{
"ShipperCode": "YD",
"ShipperName": "韵达快递"
}
]
}