目錄
1.完成前期准備工作
2.API接口
3.請求完整報文(示例)
4.成功返回報文(示例)
5.失敗返回報文(示例)
6.分步講解(C#版本)
7.極兔速遞電子面單打印模板內容(HTML)
8.關于簽名
前言
J&T 極兔速遞是一家科技創新型互聯網快遞物流企業,致力于爲用戶帶來優質的快遞和物流體驗。
2015年8月由印尼首都雅加達作爲起點,進入快遞物流市場,目前覆蓋了印度尼西亞、越南、馬來西亞、泰國、菲律賓、柬埔寨及新加坡七個國家,成爲東南亞超過5.5億人口信賴的綜合性物流服務商。
電子面單模板效果圖:
電子面單打印模板規格列表:
快遞公司名稱編碼模板樣式尺寸規格TemplateSize字段CustomArea字段極兔速遞JTSD一聯130寬76**m**m 高130mm傳值130支持極兔速遞JTSD二聯180寬100**m**m 高180mm 切點110/70默認返回,不能傳值–
1.完成前期准備工作
1.1,去快遞鳥免費注冊一個對接賬號
1.2,免費獲得一個apiKey(接口權限驗證需要)
1.3,完成實名認證流程
1.4,訂購一個免費套餐
1.5,准備打印機、打印紙
打印機:電子面單模板對打印機品牌、型號等沒有要求,只要是熱敏打印機即可,常見品牌如:斑馬、得力、快麥、漢印、佳博等。
打印機可由快遞網點提供或者在淘寶京東上購買, 安裝打印機及驅動程序聯系打印機提供方;
打印紙:打印紙可由快遞網點提供或者在淘寶京東上購買,購買時可選擇全白熱敏 紙。
2.API接口
2.1,測試調用地址:http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
2.2,正式調用地址:http://api.kdniao.com/api/EOrderService
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.請求報文(示例)
{“PayType”: 1,”CustomerName”: “J0086030000″,”CustomerPwd”: “Jt888888″,”ExpType”: 1,”ShipperCode”: “JTSD”,”OrderCode”: “300008886539888”,”IsNotice”: 1,”IsReturnPrintTemplate”: 1,”Commodity”: [{“GoodsName”: “其他”,”Goodsquantity”: 1,”GoodsWeight”: 0}],”Sender”: {“Name”: “王寶劍”,”Mobile”: “13988888888”,”ProvinceName”: “北京市”,”CityName”: “北京市”,”ExpAreaName”: “西城區”,”Address”: “北京市西城區西直門南小街國英1號1020″},”Receiver”: {“Name”: “劉小刀”,”Mobile”: “18809999999”,”ProvinceName”: “廣東省”,”CityName”: “深圳市”,”ExpAreaName”: “福田區”,”Address”: “廣東省深圳市福田區華寶一號大廈”}}
4.成功返回報文(示例)
{Order={LogisticCode=JT0000131754417, PackageName=180 600-01 001, OrderCode=300008886539888, KDNOrderCode=KDN2005141650003168, SortingCode=180 600-01 001}, PrintTemplate=打印html內容, EBusinessID=1237100,UniquerRequestNumber=f3ba8bf3-cb4c-4f06-8aee-7fba1e0e8376, ResultCode=100, Reason=成功, Success=true}
5.失敗返回報文(示例)
{ “EBusinessID”: “1237100”, “ResultCode”: “106”, “Reason”: “該訂單號已下單成功”, “UniquerRequestNumber”:”5e66486b-8fbc-4131-b875-9b13d2ad1354″ }
6.分步講解(C#版本)
6.1,請求數據包結構
6.2,C#調用代碼示例
技術支持:QQ:510997342//電商IDstring eEBusinessID = “test1617571”; //電商加密私鑰,快遞鳥提供,注意保管,不要泄漏string appKey= “554343b2-7252-439b-b4eb-1af42c8f2175”; //請求urlstring reqURL = “http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json”;//請求指令 string reqType=”1007″;//2-json string dataType = “2”; //字符編碼采用UTF-8 string charset = “UTF-8”; //JSON字符串string string jsonStr = “json請求報文示例” ;//把(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的方法就能獲取到裏面的字段信息。
6.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; }
7.極兔速遞電子面單打印模板內容(HTML)
<style>.item {position: absolute;}</style><div class=”item hline” style=”left:0.5px;top:1px;width:373px;height:0;border-top:1px solid #000″></div><div class=”item vline” style=”left:3px;top:1px;height:681px;width:0;border-left:1px solid #000;”></div><div class=”item vline” style=”left:371px;top:2px;height:681px;width:0;border-left:1px solid #000;”></div><div class=”item hline” style=”left:1.5px;top:682px;width:369px;height:0;border-top:1px solid #000″></div><!–<div class=”item text” style=”left:28.5px;top:9px;width:113px;height:38px;font-family:”Microsoft Yahei”;font-size:22px;font-weight:400;overflow:visible”>Company</div>–><div class=”item hline” style=”left:4.5px;top:60px;width:366px;height:0;border-top:1px solid #000″></div><div class=”item text” style=”background:#000;color:#fff;left:234.5px;top:5px;width:107px;height:28px;font-family:”Microsoft Yahei”;font-size:20px;font-weight:400;overflow:visible; display: none;”> 代 收 貨 款</div><div class=”item text” style=”left:220.5px;top:38px;width:144px;height:18px;font-family:”Microsoft Yahei”;font-size:12px;font-weight:400;overflow:visible”>服務熱線: 400 820 1666</div><div class=”item hline” style=”left:3.5px;top:151px;width:366px;height:0;border-top:1px solid #000″></div><div class=”item text” style=”left:15px;top:63px;width:260px;height:42px;font-family:”Microsoft Yahei”;font-size:32px;font-weight:400;overflow:visible”>180 600-01 001</div><div class=”item text” style=”left:316.5px;top:67px;width:40px;height:37px;font-family:”Microsoft Yahei”;font-size:16px;font-weight:500;overflow:visible”>標准快遞</div><img class=”item image” style=”left:14.5px;top:160px;width:39px;height:34px;” src=””><img class=”item image” style=”left:17.5px;top:215px;width:31px;height:33px;” src=””><img class=”item image” style=”left:16.5px;top:258px;width:31px;height:31px;” src=””><div class=”item ” style=”left: 80px; top: 180px; width: 370px; height: 120px; fopacity: 1.0; padding-left: 20px; font-weight: bold;”> <img style=”left: 40px; top: 120px; width: 270px; height: 100px; ” src=”” /></div><!–<img class=”item image” style=”left:25.5px;top:117px;width:25px;height:23px;” src=””>–><div class=”item text” style=”left:220.5px;top:113px;width:65px;height:19px;font-family:”Microsoft Yahei”;font-size:12px;font-weight:400;overflow:visible”>打印時間:</div><div class=”item text” style=”left:282.5px;top:111px;width:83px;height:33px;font-family:”Microsoft Yahei”;font-size:12px;font-weight:400;overflow:visible”>2020/05/14 16:05:12 </div><div class=”item hline” style=”left:4.5px;top:211px;width:368px;height:0;border-top:1px dashed #000″></div><div class=”item vline” style=”left:58px;top:151px;height:140px;width:0;border-left:1px solid #000;”></div><div class=”item text” style=”left:63px;top:153px;width:305px;height:25px;font-family:”Microsoft Yahei”;font-size:12px;font-weight:400;overflow:hidden;ine-height: 95%”>劉小刀 18809999999 </div><div class=”item text” style=”left:63px;top:183px;width:305px;height:26px;font-family:”Microsoft Yahei”;font-size:12px;font-weight:400;overflow:hidden;ine-height: 93%”>廣東省深圳市福田區華寶一號大廈</div><div class=”item hline” style=”left:3.5px;top:255px;width:368px;height:0;border-top:1px dashed #000″></div><div class=”item text” style=”left:63px;top:213px;width:305px;height:18px;font-family:”Microsoft Yahei”;font-size:10px;font-weight:400;overflow:hidden”>王寶劍 13988888888 </div><div class=”item text” style=”left:63px;top:230px;width:305px;height:24px;font-family:”Microsoft Yahei”;font-size:10px;font-weight:400;overflow:hidden”> 北京市西城區西直門南小街國英1號1020</div><div class=”item hline” style=”left:0.5px;top:291px;width:373px;height:0;border-top:1px solid #000″></div><div class=”item hline” style=”left:59.5px;top:272px;width:310px;height:0;border-top:1px dashed #000″></div><div class=”item text” style=”left:74.5px;top:255px;width:54px;height:20px;font-family:”Microsoft Yahei”;font-size:12px;font-weight:400;overflow:visible;”>代收貨款</div><div class=”item text” style=”left:179.5px;top:255px;width:56px;height:16px;font-family:”Microsoft Yahei”;font-size:12px;font-weight:400;overflow:visible”>到付運費</div><div class=”item text” style=”left:288.5px;top:254px;width:62px;height:20px;font-family:”Microsoft Yahei”;font-size:12px;font-weight:400;overflow:visible”>計件重量 </div><div class=”item vline” style=”left:152px;top:254px;height:38px;width:0;border-left:1px solid #000;”></div><div class=”item vline” style=”left:265px;top:254px;height:38px;width:0;border-left:1px solid #000;”></div><div class=”item text” style=”left:66.5px;top:272px;width:73px;height:20px;font-family:”Microsoft Yahei”;font-size:12px;font-weight:400;overflow:visible”>0</div><!–<div class=”item text” style=”left:184.5px;top:272px;width:48px;height:21px;font-family:”Microsoft Yahei”;font-size:12px;font-weight:400;overflow:visible”>¥Cost</div>–><div class=”item text” style=”left:289.5px;top:271px;width:55px;height:16px;font-family:”Microsoft Yahei”;font-size:12px;font-weight:400;overflow:visible”></div><div class=”item hline” style=”left:2.5px;top:416px;width:368px;height:0;border-top:1px solid #000″></div><div class=”item text” style=”left:6.5px;top:366px;width:90px;height:16px;font-family:”Microsoft Yahei”;font-size:12px;font-weight:400;overflow:visible”>簽收人/時間:</div><div class=”item text” style=”left:4.5px;top:384px;width:268px;height:27px;font-family:”Microsoft Yahei”;font-size:12px;font-weight:400;overflow:visible”>您的簽收代表您已接收此包裹,並確認商品信息無誤,包裹完好、沒有劃痕、破損等表面質量問題</div><img class=”item image” style=”left:26.5px;top:496px;width:34px;height:35px;” src=””><img class=”item image” style=”left:26.5px;top:545px;width:33px;height:32px;” src=””><div class=”item vline” style=”left:77px;top:498px;height:82px;width:0;border-left:1px solid #000;”></div><div class=”item text” style=”left:80px;top:494px;width:290px;height:18px;font-family:”Microsoft Yahei”;font-size:12px;font-weight:400;overflow:hidden”>劉小刀 18809999999 </div><div class=”item text” style=”left:80px;top:514px;width:290px;height:30px;font-family:”Microsoft Yahei”;font-size:12px;font-weight:400;overflow:hidden”>廣東省深圳市福田區華寶一號大廈</div><div class=”item text” style=”left:80px;top:543px;width:290px;height:18px;font-family:”Microsoft Yahei”;font-size:12px;font-weight:400;overflow:hidden”>王寶劍 13988888888 </div><div class=”item text” style=”left:80px;top:563px;width:290px;height:30px;font-family:”Microsoft Yahei”;font-size:12px;font-weight:400;overflow:hidden”>北京市西城區西直門南小街國英1號1020</div><div class=”item text” style=”left:12.5px;top:603px;width:300px;height:80px;font-family:”Microsoft Yahei”;font-size:14px;font-weight:400;overflow:visible”>備注: 數量:1 重量:0kg 其他</div><div class=”item text” style=”left:313.5px;top:657px;width:56px;height:20px;font-family:”Microsoft Yahei”;font-size:14px;font-weight:400;overflow:visible”>已檢視</div><!–<div class=”item text” style=”left:16.5px;top:578px;width:65px;height:20px;font-family:”Microsoft Yahei”;font-size:14px;font-weight:400;overflow:visible”>備注</div>–><div class=”item” style=”left:8.5px;top:295px;width:350px;height:60px;font-family:”Microsoft Yahei”;font-size:14px;font-weight:400;overflow:visible”> <img src=”” /></div><div class=”item text” style=”left:110px;top:350px;width:170px;height:20px;font-family:”Microsoft Yahei”;font-size:14px;font-weight:400;overflow:visible”>JT0000131754417</div><div class=”item” style=”left:190px;top:423px;width:178px;height:55px;font-family:”Microsoft Yahei”;font-size:14px;font-weight:400;overflow:visible”> <img src=”” /></div><div class=”item text” style=”left:208px;top:475px;width:160px;height:20px;font-family:”Microsoft Yahei”;font-size:12px;font-weight:400;overflow:visible”>JT0000131754417</div><img class=”item image” style=”left:286.5px;top:345px;width:82px;height:68px;” src=””>
複制以上HTML內容保存爲html格式的文件,可以查看模板效果。
8.關于簽名
快遞鳥和第三方電子商務公司系統進行對接,有一定的安全機制。采用 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 相當于用戶名,