免费物流快递API接口的要求

2021-08-26 23:37:42

一家一家快递公司去对接查询接口，比较耗时、耗成本，一般都会选择集成物流接口服务商，淘系用菜鸟，非淘系的用快递鸟，快递鸟是第三方物流接口服务商中比较好的，集成了全球418家物流快递公司接口，为电商平台、电商系统商（ERP）、仓储（WMS）、小程序等有系统的用户提供智选物流、预约取件、实名快递、电子面单、隐私快递、快递单号查询、快递单号智能识别、物流评价、物流短信提醒等全流程的物流接口解决方案，接口比较全面，支持的快递公司多，接口稳定性及时性准确性都有保障，电商平台蘑菇街、拼多多、国美、网易考拉接的就是快递鸟的接口，也有很多ISV服务商（比如网店管家、商派、E店宝）也对接了快递鸟API，使用快递鸟物流查询API接口的用户很多（有十几个千人技术QQ群），淘系用菜鸟，非淘系的用快递鸟，快递鸟是第三方物流接口服务商中用户使用最多的，服务数据量最大的，日服务单在3000万+以上，服务体系也比较完善，有专门的客服、在线的技术支持、上门的技术服务指导、专业的物流方案服务顾问，在北京上海主要城市设有分公司团队，和大部分物流快递公司有接口对接及战略合作协议，确保数据的安全稳定及时准确，整个对接过程也挺简单的，到快递鸟网站注册申请到ApiKey和商户ID，对接后联调测试后上线就可以使用了，在快递鸟网站也可下载demo，对接更简单便捷，一次性对接418家物流快递公司接口。那么使用快递鸟api接口有哪些规则呢？

本文档就各个API接口进行详细说明，方便用户快速对接及使用快递鸟api接口服务。

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 名词定义

必须要求

说明

必填(Required)。

可选(Optional)

一定条件下可选(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版本)供开发参考。