2.API接口
3.要求参数(Headers)
4.要求参数(Body)

5.返回参数(Return)
6.要求完全报文(示例)
7.成功返回报文(示例)
8.失落败返回报文(示例)
9.无轨迹返回报文(示例)
10.分步讲解(C#版本)
11.关于署名
1.完成前期准备事情
1.1,去快递鸟官网免费注册一个账号
1.2,免费得到一个apiKey(接口权限验证须要)
1.3,完成实名认证流程
1.4,订购一个免费套餐
2.API接口
2.1,测试调用地址:http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
2.2,正式调用地址:http://api.kdniao.com/api/dist
2.3,要求办法:POST
2.4,编码格式(utf-8):application/x-www-form-urlencoded;charset=utf-8
2.5,返回类型:JSON
2.6,调试页面:http://kdniao.com/UserCenter/v2/SandBox/TrackQuery.aspx
2.7,调试工具:去调试(利用快递鸟账号登录)
3.要求参数(Headers)
参数名称类型解释必须哀求RequestDataString要求内容需进行URL(utf-8)编码,要求内容JSON格式,须和DataType同等必填EBusinessIDString用户ID,查看用户ID和ApiKey必填RequestTypeString要求指令类型:1002 必填DataSignString署名数据,(Body+ApiKey)进行MD5加密,再进行Base64编码,最后进行URL(utf-8)编码必填DataTypeString求、返回数据类型:2-json ,默认Json选填
4.要求参数(Body)
参数名称类型解释必须哀求OrderCodeString订单编号选填ShipperCodeString快递公司编码必填LogisticCodeString物流运单号必填
参数报文:{'OrderCode':'','ShipperCode':'AUEX','LogisticCode':'ZA02673754999'}
5.返回参数(Return)
参数名称类型解释必须哀求EBusinessIDString用户ID 必填ShipperCodeString快递公司编码 必填LogisticCodeString物流运单号选填SuccessString成功与否必填ReasonString失落败缘故原由选填StateString物流状态:2-在途中,3-签收,4-问题件必填Traces String韶光 AcceptTimeString 必填AcceptStationString描述 选填RemarkString备注必填
6.要求完全报文(示例)
RequestData=%7b%27OrderCode%27%3a%27%27%2c%27ShipperCode%27%3a%27AUEX%27%2c%27LogisticCode%27%3a%27ZA02673754999%27%7d&EBusinessID=1264783&RequestType=1002&DataSign=MjdjZTg5ZDJiMzliYjY0YmY2NjAyZGMzYWUzODIwZjk%3d&DataType=2
7.成功返回报文(示例)
{"LogisticCode": "ZA02673754999","ShipperCode": "AUEX","Traces": [{"AcceptStation": "运单已创建, 等待收货","AcceptTime": "2020-03-24 11:15:43"},{"AcceptStation": "运单扫描,正在分拣","AcceptTime": "2020-03-29 16:00:47"},{"AcceptStation": "预分配转运单号","AcceptTime": "2020-03-29 16:00:47"},{"AcceptStation": "运单详情已录入系统","AcceptTime": "2020-03-29 16:00:52"},{"AcceptStation": "已安排航班","AcceptTime": "2020-03-29 16:00:52"},{"AcceptStation": "货色打板装车,准备运往机场","AcceptTime": "2020-03-29 19:03:56"},{"AcceptStation": "货色已送机场","AcceptTime": "2020-04-05 18:00:29"},{"AcceptStation": "提交清关报告材料,清关处理中","AcceptTime": "2020-04-14 09:16:14"},{"AcceptStation": "清关处理中","AcceptTime": "2020-04-16 10:35:40"},{"AcceptStation": "清关处理中","AcceptTime": "2020-04-18 12:36:56"},{"AcceptStation": "清关处理中","AcceptTime": "2020-04-20 08:02:48"},{"AcceptStation": "清关处理中","AcceptTime": "2020-04-22 11:13:21"},{"AcceptStation": "清关处理中","AcceptTime": "2020-04-24 09:27:54"},{"AcceptStation": "清关处理中","AcceptTime": "2020-04-26 08:23:09"},{"AcceptStation": "清关处理中","AcceptTime": "2020-04-28 11:08:29"}],"State": "2","EBusinessID": "1264783","Success": true}
8.失落败返回报文(示例)
{"LogisticCode": "ZA02673754999", "ShipperCode": "AUEX", "Traces": [], "State": "0", "EBusinessID": "1264783", "Reason": "业务缺点[没有可用套餐]", "Success": false }
解释:未实名认证,未订购套餐,套餐可用查询量已经用完 都会返回此报文信息去实名认证 / 理解套餐详情
9.无轨迹返回报文(示例){ "LogisticCode" : "ZA02673754999", "ShipperCode" : "AUEX", "Traces" : [ ], "State" : "0", "EBusinessID" : "1264783", "Reason" : "暂无轨迹信息", "Success" : true }
10.1,要求数据包构造
10.2,C#调用代码示例
//电商IDstring eEBusinessID = "test1617571"; //电商加密私钥,快递鸟供应,把稳保管,不要泄露string appKey= "554343b2-7252-439b-b4eb-1af42c8f2175"; //要求urlstring reqURL = "http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json";//要求指令 string reqType="1002";//2-json string dataType = "2"; //字符编码采取UTF-8 string charset = "UTF-8"; //JSON字符串string string jsonStr = "{\"OrderCode\":\"\",\"ShipperCode\":\"AUEX\",\"LogisticCode\":\"ZA02673754999\"}" ;
//把(jsonStr+APIKey)进行MD5加密 string md5Str=MD5(jsonStr + apiKey, charset); //把md5Str 进行Base64编码 string base64Str=base64(md5Str,charset); //进行URL编码 (utf-8) string datasign = HttpUtility.UrlEncode(base64Str, charset); //要求报文参数 string postStr = "RequestType=reqType&EBusinessID= eEBusinessID&RequestData=jsonStr &DataSign= datasign&DataType=dataType"; //通讯协议利用Http协议Post要求办法 返回轨迹数据 string post = SendPost(reqURL, postStr); //获取到的post数据便是快递鸟返回的完全报文,接下来自己写一个解析json的方法就能获取到里面的字段信息。
10.3,C#调用方法
///<summary> /// 字符串MD5加密 ///</summary> ///<param name="str">要加密的字符串</param> ///<param name="charset">编码办法</param> ///<returns>密文</returns> private string MD5(string str, string charset) { byte[] buffer = System.Text.Encoding.GetEncoding(charset).GetBytes(str); 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; } } /// <summary> /// base64编码 /// </summary> /// <param name="str">内容</param> /// <param name="charset">编码办法</param> /// <returns></returns> private string base64(String str, String charset) { return Convert.ToBase64String(System.Text.Encoding.GetEncoding(charset).GetBytes(str));} /// <summary> /// Post办法提交数据,返回网页的源代码 /// </summary> /// <param name="url">发送要求的 URL</param> /// <param name="postData">要求报文参数</param> /// <returns>远程资源的相应结果</returns> private string SendPost(string url, string postData) { string result = ""; byte[] byteData = Encoding.GetEncoding("UTF-8").GetBytes(postData.ToString()); try { HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url); request.ContentType = "application/x-www-form-urlencoded"; request.Referer = url; request.Accept = "/"; request.Timeout = 30 1000; request.UserAgent = "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 2.0.50727; .NET CLR 3.0.04506.648; .NET CLR 3.0.4506.2152; .NET CLR 3.5.30729)"; request.Method = "POST"; request.ContentLength = byteData.Length; Stream stream = request.GetRequestStream(); stream.Write(byteData, 0, byteData.Length); stream.Flush(); stream.Close(); HttpWebResponse response = (HttpWebResponse)request.GetResponse(); Stream backStream = response.GetResponseStream(); StreamReader sr = new StreamReader(backStream, Encoding.GetEncoding("UTF-8")); result = sr.ReadToEnd(); sr.Close(); backStream.Close(); response.Close(); request.Abort(); } catch (Exception ex) { result = ex.ToString(); } return result; }
11.关于署名
快递鸟和第三方电子商务公司系统进行对接,有一定的安全机制。采取 IP 认证加署名的办法对接,详细方案如下:
防止数据被修改 在 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 编码),天生择要,比拟两者的摘假如否相同,如果不同,解释通报过程中发生数据修改。 调用接口的身份认证 注册成为快递鸟用户后,会天生对应的用户 ID 和 APIKey,用户 ID 相称于用户名, APIKey 相称于密码。