快递鸟全球物流单号查询api接口

快递鸟全球物流单号查询API接口旨在为电商、电商平台、物流工具、打单工具、仓储系统、移动APP等系统提供专业、稳定、优质的API 接口服务,知足不一样用户的物流管理需求。本文档就各个API接口进行详细说明,方便用户快速对接及使用快递鸟服务。
快递鸟全球物流单号查询api接口php

快递鸟集合全球418家快递物流公司系统,打包成统一标准接口,为电商仓储,ERP系统,电商平台,跨境电商、仓储(WMS)、小程序等有系统的用户提供物流快递单号查询接口解决方案,支持高并发、支持的快递公司多、接口稳定性、及时性都有保障。java

目前为止,已有各大商家、电商平台、仓储、清关公司、ERP、WMS、TMS、CRM、快递柜等至少十万家发货方在使用快递鸟API对接解决方案,包括发货管理、智选物流、电子面单、货物在途监控、货款金融等全流程物流服务。另外一端物流服务方也有全球四百多家物流快递公司与快递鸟完成接口对接。电商平台蘑菇街、拼多多、国美、网易考拉接的就是快递鸟的接口,也有不少ISV服务商(好比网店管家、商派、E店宝)也对接的快递鸟API接口。算法

【电商快递单号查询场景需求描述】
电商平台及ISV商家对物流api接口的需求有不少,今天咱们主要分享的就是快递鸟快递单号查询接口的对接指南,快递单号查询接口对接的应用场景有不少,不少场景会遇到,最主要的就是电商网站用户打开“个人订单”时调用此API显示物流信息详情,电商管理后台的物流系统,客服在对帐前查询全部运单的签收状态,并追踪问题,电商平台对商家物流管控,要求必须在多久快递必须发出要看到揽件状态,多久必须收到货物看到签收状态,根据这些状态对商家管控从而提升用户的总体满意度。下图是电商平台、买家、商家的下单发货流程图。json

【快递单号查询接口对接使用流程】
一、将快递单号和快递公司编码发送給快递鸟
二、快递鸟根据单号和快递公司查询到物流轨迹状态
三、快递鸟将查询到的物流轨迹状态反馈給电商平台或ISV服务商
四、电商平台或ISV服务商接收数据并实时处理作数据展现或应用小程序

【快递单号查询接口描述说明】
(1)查询接口支持按照运单号查询(单个查询)。
(2)接口须要指定快递单号的快递公司编码,格式不对或则编码错误都会返失败的信息。
如:EMS物流单号应选择快递公司编码(EMS)查看快递公司编码
(3)返回的物流跟踪信息按照发生的时间升序排列。
(4)接口指令1002。
(5)接口支持的消息接收方式为HTTP POST,请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
(6)测试地址:http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
(7)正式地址:http://api.kdniao.com/Ebusiness/EbusinessOrderHandle.aspx
请求系统级参数说明:api

备注:R-必填(Required),O-可选(Optional),C-报文中该参数在必定条件下可选(Conditional)
【接口参数】
请求内容字段定义:安全

返回参数定义:并发

【快递单号查询接口示例】app

没有物流轨迹的
{
"EBusinessID": "1109259",
"Traces": [],
"OrderCode": "",
"ShipperCode": "SF",
"LogisticCode": "118461988807",
"Success": false,
"Reason": null
}
有物流轨迹的
{
"EBusinessID": "1109259",
"OrderCode": "",
"ShipperCode": "SF",
"LogisticCode": "118461988807",
"Success": true,
"State": 3,
"Reason": null,
"Traces": [
{
"AcceptTime": "2014/06/25 08:05:37",
"AcceptStation": "正在派件..(派件人:邓裕富,电话:18718866310)[深圳 市]",
"Remark": null
},
{
"AcceptTime": "2014/06/25 04:01:28",
"AcceptStation": "快件在 深圳集散中心 ,准备送往下一站 深圳 [深圳市]",
"Remark": null
},
{
"AcceptTime": "2014/06/25 01:41:06",
"AcceptStation": "快件在 深圳集散中心 [深圳市]",
"Remark": null
},
{
"AcceptTime": "2014/06/24 20:18:58",
"AcceptStation": "已收件[深圳市]",
"Remark": null
},
{
"AcceptTime": "2014/06/24 20:55:28",
"AcceptStation": "快件在 深圳 ,准备送往下一站 深圳集散中心 [深圳市]",
"Remark": null
},
{
"AcceptTime": "2014/06/25 10:23:03",
"AcceptStation": "派件已签收[深圳市]",
"Remark": null
},
{
"AcceptTime": "2014/06/25 10:23:03",
"AcceptStation": "签收人是:已签收[深圳市]",
"Remark": null
}
]
}ide

【接入流程】

快递鸟单号自动识别接口(API)接入视频教程
快递鸟单号查询接口(API)接入视频教程​​​​​​​

登陆快递鸟官网注册页面注册快递鸟帐号
登陆快递鸟用户管理后台
注:登陆快递鸟用户管理后台后得到用户ID和APIKey对应各demo中的EBusinessID、AppKey。
小知识:EBusinessID跟APIKey是什么?EBusinessID跟APIKey您在快递鸟网站注册以后快递鸟分配的密钥(对应官网上的用户ID和API key),用于保证应用来源的可靠性,避免应用伪造,被不法使用。
3.进入“个人会员中心”进行实名认证

3.一、认证类型、应用类型根据用户实际状况选择便可,接口返回数据与选择结果无关;
3.二、标记为*的为必填,要求上传清晰、jpg格式且小于2M的证件图片;
3.三、技术对接人信息为用户方对接工程师的信息;
3.四、若有其余疑问可进入快递鸟官网加入右侧的QQ群进行咨询。
4.认证成功后,进入“产品服务管理”,开通相关会员服务

4.一、物流查询(免费版)会员套餐为免费版,有效期1年结束后,如在近3个月内有数据交互系统会自动免费续期;
4.二、若有其余疑问可进入官网加入商务合做群(群号:616310430)进行咨询。
5.开发对接
5.一、即时查询(RequestType:1002/8001)日查询次数<=3000次对接即时查询接口
5.1.一、请求接口以前须要先实名认证,开通相关会员服务,不然会请求失败并返回提示“未申请开通接口”;
5.1.二、接口开发能够下载“快递鸟接口技术文档”进行参考;即时查询,参考技术文档中的4.1或5.1.1部分;
5.1.三、接口开发能够下载“即时查询demo”进行参考(仅提供了.NET、Java、PHP三种语言demo);
5.1.四、查看快递公司对应快递鸟的编码能够下载“2018快递鸟接口支持快递公司编码列表.xlsx”。
5.1.五、接入过程当中若有疑问请先参考快递鸟官网常见问题进行解决,也能够进入快递鸟官网加入技术对接群进行咨询。
5.二、物流跟踪(RequestType:1008/8008)日查询次数>3000次对接物流跟踪接口
5.2.一、请求接口以前须要先实名认证,开通相关会员服务,不然会请求失败并返回提示“未申请开通接口”;
5.2.二、接口开发需下载“快递鸟接口技术文档”进行查看;物流跟踪,参考技术文档中的4.2或5.1.2部分;
5.2.三、开发订阅接口:
5.2.3.一、能够下载“物流跟踪demo”进行参考(仅提供了.NET、Java、PHP三种语言的demo),
其余语言开发的用户须要根据技术文档自行开发;
5.2.3.二、测试订阅接口,对照技术文档正确返回表明订阅接口对接成功,详情可见技术文档。
5.2.四、开发推送接口:
5.2.4.一、无demo提供,推送时会推送requestType、requestData和DataSign三个参数,您开发一个推送接口接收这三个参数就行,成功接收后须要在5S内给快递鸟返回成
功收数据的报文,不然超时。RequestData中包含应用级参数,即物流轨迹(详情看技术文档);
5.2.4.二、在沙箱调试平台(沙箱调试平台地址:http://kdniao.com/UserCenter/v2/SandBox/PushQueryParam.aspx)配置回调地址,测试推送接口。回调地址是用户提供
用于接收快递鸟推送的物流信息的,只要是外网能够访问的就行。测试、配置步骤以下:
a、填写回调地址:

b、点击【生成】后 应用级参数报文(RequestData)就是推送到用户第一步时填写的回调地址上的测试物流信息。
c、点击【调用】,用户接收到测试的物流信息后,用户须要在 应用级参数报文区域 返回成功接收的信号给快递鸟(注:字段间不要存在空格,空格会影响返回结果),
返回格式:{"EBusinessID":"1237100","UpdateTime":"2015-03-11 16:26:11","Success":true,"Reason": ""}

d、调用结果显示为请求成功后即用户开发的推送接口经过测试。
e、测试经过后回到第一步填写回调地址的位置点击【配置】,弹出弹框,填写手机号(必须是注册快递鸟帐号的手机号)、验证码、
回调地址,点击【保存】配置成功便可在正式环境使用,下次若是须要修改回调地址同初次配置回调地址步骤一致。

​5.2.五、订阅接口、推送接口分别测试成功后,可以使用正式地址进行订阅真实的快递单号,快递鸟通常会在2-12小时内推送物流信息至您已经配置好的回调地址上;
5.2.六、接口开发查看快递公司对应快递鸟的编码能够下载“2019快递鸟接口支持快递公司编码列表.xlsx”;
5.2.七、接入过程当中若有疑问请先参考快递鸟官网常见问题进行解决,也能够进入快递鸟官网加入技术对接群进行咨询。

【你可能还关心的问题】
一、问题:快递鸟接口有并发要求吗?
快递鸟即时查询接口并发不超过10次/秒,物流跟踪接口订阅不超过30次/秒,电子面单接口下单不超过20次/秒。
二、问题:快递鸟api收费标准是什么?
快递鸟查询接口和电子面单等接口都是免费提供的,若是您对数据的状态时效、服务等有特别的需求,可联系快递鸟工做人员,为您量身定制专属解决方案,具体收费会根据您的需求进行商定。
三、问题:快递鸟数据更新实时性如何?
即时查询接口:实时获取当前最新轨迹信息,数据与官网信息一致。
物流跟踪接口:快递鸟每2小时到快递公司获取轨迹,若是您订阅的单号没有轨迹更新,间隔2小时后再次到快递公司获取轨迹,依次循环直到有物流轨迹更新,获取到新轨迹后进行排队序列推送。
四、问题:快递鸟数据准确性,会不会存在物流状态不许确的问题?
轨迹信息准确度大于99.9%。物流轨迹信息保持与快递公司官网一致,偶尔存在快递公司提供的接口数据与官网不一致的状况,不一致状况小于0.1%。
五、问题:快递鸟即时查询接口和物流跟踪接口有什么区别?
(1)接入方式不同:
即时查询接口,根据快递单号和快递公司编码实时查询物流轨迹信息。
物流跟踪接口,用户订阅快递号,快递鸟系统会定时推送新的物流信息。
(2)实现的功能不同:
即时查询接口,单次请求只能查询一个单的物流信息,支持10次/S的并发请求。
物流跟踪接口,订阅推送的模式获取轨迹信息,发起一次订阅后,快递鸟会持续监控推送更新的轨迹信息,直到签收。
(3)查询单量不同:
即时查询每日查询次数<=3000次,物流跟踪不限制订阅单量,并可一直得到每一个单号的更新信息。
六、问题: 快递鸟物流跟踪数据的时效性怎样?
在接收到新的快递单后,会当即加入监控队列,有结果的话会即时内返回,没有结果的话,会等待必定时间(如2小时)再进行下一次监控。对于这些后续的监控,若是某运单号在快递公司官网对应的结果B,B最新一条状态所对应的时间为T1,快递鸟将B推送给贵公司的时间为T2,那么|T2-T1|通常在0~2~4 个小时之内,但我方会不断地向贵方进行推送,使运单状态能持续地更新。
七、问题:快递鸟物流跟踪是须要咱们本身开发接收接口是吗?
对接物流跟踪接口,你须要开发订阅接口(将单号和快递公司编码订阅给快递鸟。有订阅接口的.net,php和java版本demo,你能够参考下。还有本身开发一个推送接口(接收快递鸟推送的物流轨迹),开发完后登陆快递鸟沙箱后台调试推送接口,调试成功后可在沙箱后台自助配置推送接口。
八、问题:快递鸟物流跟踪的推送接口怎么作?
推送接口是用于接收推送的物流信息,推送接口是咱们调用你的接口,你只须要接收参数,在沙箱后台配置你的回调地址就行,RequestData中包含应用级参数,即物流轨迹,推送时会推送requestType、requestData和DataSign三个参数(详情看技术文档),您开发一个推送接口接收这三个参数就行。
九、问题:快递鸟的物流跟踪API实现原理是什么?
订阅接口的工做原理是:用户将快递单号订阅给咱们,咱们即刻加入队列去物流公司官方接口查询,查询有轨迹就给用户推送。若是没有更新数据,两个小时后会再次去物流公司官方接口查询,有新数据就将全量数据推送给用户,若是没有更新数据,两个小时后再重复上述动做,直到运单签收。
十、问题:快递鸟支持哪些快递物流公司查询接口?
快递鸟支持418家快递物流公司的接口,具体在快递鸟官网下载《2019快递鸟接口支持快递公司编码.xlsx》查看。

1 接口规范说明

1.1 接口规范及说明

1.1.1 报文及报文编码

报文格式:Json格式

请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"

交互协议上统一用UTF-8,避免传递中文数据出现乱码。

1.1.2 接口数据包结构

图例- 数据包结构(系统级{数据})

1.1.3 JSON示例

string used = "1237100";//仅做为示例ID,不可用来实际使用
//加密私钥,由快递鸟提供
string keyValue = "56da2cf8-c8a2-44b2-b6fa-476cd7d1ba17";//仅做为示例Key,不可用来实际使用
//请求地址
string url = "http://api.kdniao.com/Ebusiness/EbusinessOrderHandle.aspx";
//2-json
string DataType = "2";
//字符编码采用UTF-8
string charset = "UTF-8";
//JSON字符串string
string jsonStr = "{\"OrderCode\":\"\",\"ShipperCode\":\"SF\",\"LogisticCode\":\"118461988807\"}";
//把(jsonStr+APIKey)进行MD5加密,而后Base64编码,最后 进行URL(utf-8)编码
datasign = HttpUtility.UrlEncode(base64(MD5(jsonStr + keyValue, "UTF-8"), "UTF-8"), Encoding.UTF8);
//请求报文参数
string PostStr = "RequestType=1002&EBusinessID= used &RequestData=jsonStr &DataSign= datasign&DataType=DataType";
//通信协议使用Http协议Post请求方式
string post = this.DoPost(url, PostStr);
1.1.4 系统级参数

*快递全部接口统一使用此系统级参数,根据不一样的请求接口指令接入不一样的接口。

1.1.5 流程示意图

1.1.6 名词定义

必需要求

说明

R

必填(Required)。

O

可选(Optional)

C

必定条件下可选(Conditional)

1.2 签名说明

1.2.1 关于签名

快递鸟和第三方电子商务公司系统进行对接,有必定的安全机制。采用IP认证加签名的方式对接,具体方案以下:

1.防止数据被篡改

在POST请求中会传递5个必须(R)参数

RequestData==数据内容(URL编码:UTF-8)

EBusinessID==用户ID

RequestType=请求指令类型

DataSign== 数据内容签名:把(请求内容(未编码)+ApiKey)进行MD5加密,而后Base64编码,最后进行URL(utf-8)编码

DataType==2(返回数据类型为json)

注:

DataSign生成后,对方接收到数据后,以一样的算法进行签名(推送接口RequestType为101/102不须要进行URL编码),生成摘要,对比二者的摘要是否相同,若是不一样,说明传递过程当中发生数据篡改。

2.调用接口的身份认证

注册成为快递鸟用户后,会生成对应的用户ID和APIKey,用户ID至关于用户名,APIKey至关于密码。

举例:

1.假设

RequestData (JSON)内容为:

{'OrderCode':'','ShipperCode':'SF','LogisticCode':'118954907573'}

通过URL(UTF-8)编码的内容为:

%7b%27OrderCode%27%3a%27%27%2c%27ShipperCode%27%3a%27SF%27%2c%27LogisticCode%27%3a%27118954907573%27%7d;

EBusinessID=1237100【示例ID,不可用来实际使用】

APIKey=56da2cf8-c8a2-44b2-b6fa-476cd7d1ba17【示例Key,不可用来实际使用】

2.那么DataSign签名的内容为

{'OrderCode':'','ShipperCode':'SF','LogisticCode':'118954907573'}56da2cf8-c8a2-44b2-b6fa-476cd7d1ba17

通过md5和base64后的内容就为:OWFhM2I5N2ViM2U2MGRkMjc4YzU2NmVlZWI3ZDk0MmE=,

在通过URL(UTF-8)编码的内容为:OWFhM2I5N2ViM2U2MGRkMjc4YzU2NmVlZWI3ZDk0MmE%3d

最终要发送的数据为:

RequestType=1002&EBusinessID=1237100&RequestData =%7b%27OrderCode%27%3a%27%27%2c%27ShipperCode%27%3a%27SF%27%2c%27LogisticCode%27%3a%27118954907573%27%7d&DataSign=OWFhM2I5N2ViM2U2MGRkMjc4YzU2NmVlZWI3ZDk0MmE%3d&DataType=2

3.接收方收到数据后,得到

EBusinessID 和RequestData和DataSign等这几个数据。

4.接收方对EBusinessID获得APIKey,RequestData+APIKey的数据进行

md5和base64后的内容就为

OWFhM2I5N2ViM2U2MGRkMjc4YzU2NmVlZWI3ZDk0MmE=

5.接收方判断签名后的数据跟传递过来的DataSign是否一致,若是一致进行业务操做,若是不一致返回错误。

1.2.2 (C#)DataSign签名加密代码

///<summary>
///电商Sign签名
///</summary>
///<param name="content">内容</param>
///<param name="keyValue">APIkey</param>
///<param name="charset">URL编码 </param>
///<returns>DataSign签名</returns>
Public String Encrypt (String content, String keyValue, String charset)
{
if (keyValue != null)
{
return base64(MD5(content + keyValue, charset), charset);
}
return base64(MD5(content, charset), charset);
}
///<summary>
/// 字符串MD5加密
///</summary>
///<param name="Text">要加密的字符串</param>
///<returns>密文</returns>
Private string MD5(string Text, string charset)
{
byte[] buffer = System.Text.Encoding.GetEncoding(charset).GetBytes(Text);
try
{
System.Security.Cryptography.MD5CryptoServiceProvider check;
check = new System.Security.Cryptography.MD5CryptoServiceProvider();
byte[] somme = check.ComputeHash(buffer);
string ret = "";
foreach (byte a in somme)
{
if (a < 16)
ret += "0" + a.ToString("X");
else
ret += a.ToString("X");
}
return ret.ToLower();
}
catch
{
throw;
}
}
Private static string base64(String str, String charset)
{
returnConvert.ToBase64String(System.Text.Encoding.GetEncoding(charset).GetBytes(str));
}
1.3 接入步骤

1.快递鸟官网注册帐号成为快递鸟用户;

快递鸟提供的用户ID是调用接口服务的身份证实,不可更改、不可转用,API Key是应用访问API的签名附加密钥,必须妥善保存。二者关系相似于用户名和密码,二者都会在签名和业务参数中使用。

官网登陆网址:

http://www.kdniao.com/

官网注册网址:

http://www.kdniao.com/reg

官网接口介绍网址:

http://www.kdniao.com/api-all

2.登录用户后台,进行实名认证,并开通会员服务;

3.根据技术文档进行开发并在调试平台测试联调;

快递鸟提供各个API接口的DEMO(包括:.Net版本、Java版本、PHP版本)供开发参考。

DEMO下载地址:http://www.kdniao.com/documents-demo

4.系统发布上线。

注意:测试环境中获取的测试快递单号不可用于实际发货。

相关文章
相关标签/搜索