快递鸟电子面单打印接口demo.docx

快递鸟电子面单打印接口demo1 接口说明1.1 接口API(1)、支持常用20家快递电子面单打印，部分快递需要提前向网点申请电子面单账号密码，详情在附1。(2)、订单编号(OrderCode)不可重复提交，重复提交系统会返回具体错误代码。(3)、请求报文中不允许出现以下特殊字符： # & + (4)、接口使用：快递鸟网站注册申请接口API(5)、接口指令1007，只支持JSON格式1.2 系统级和应用级输入参数系统级输入参数应用级输入参数类型是否必须描述RequestData（必填参数，请求内容，JSON格式,须和DataType一致）CallBackStringO用户自定义回调信息MemberIDStringO会员标识平台方与快递鸟统一用户标识的商家IDCustomerNameStringO电子面单客户账号（与快递网点申请或通过快递鸟官网申请或通过申请电子面单客户号申请）CustomerPwdStringO电子面单密码SendSiteStringO收件网点标识ShipperCodeStringR快递公司编码LogisticCodeStringO快递单号ThrOrderCodeStringO第三方订单号OrderCodeStringR订单编号MonthCodeStringC月结编码PayTypeIntR邮费支付方式:1-现付，2-到付，3-月结，4-第三方支付ExpTypeStringR快递类型：1-标准快件IsNoticeIntO是否通知快递员上门揽件：0-通知；1-不通知；不填则默认为1CostDoubleO寄件费（运费）OtherCostDoubleO其他费用ReceiverCompanyStringO收件人公司NameStringR收件人TelStringR电话与手机，必填一个MobileStringPostCodeStringO收件人邮编ProvinceNameStringR收件省（如广东省，不要缺少“省”）CityNameStringR收件市（如深圳市，不要缺少“市”）ExpAreaNameStringO收件区（如福田区，不要缺少“区”或“县”）AddressStringR收件人详细地址SenderCompanyStringO发件人公司NameStringR发件人TelStringR电话与手机，必填一个MobileStringPostCodeStringO发件人邮编ProvinceNameStringR发件省（如广东省，不要缺少“省”）CityNameStringR发件市（如深圳市，不要缺少“市”）ExpAreaNameStringO发件区（如福田区，不要缺少“区”或“县”）AddressStringR发件详细地址StartDateStringO上门取货时间段:yyyy-MM-dd HH:mm:ss格式化，本文中所有时间格式相同EndDateStringOWeightDoubleO物品总重量kgQuantityIntO件数/包裹数VolumeDoubleO物品总体积m3RemarkStringO备注AddServiceNameString0增值服务名称ValueString0增值服务值CustomerIDString0客户标识(选填)CommodityGoodsNameStringR商品名称GoodsCodeStringO商品编码GoodsquantityIntO件数GoodsPriceDoubleO商品价格GoodsWeightDoubleO商品重量kgGoodsDescStringO商品描述GoodsVolDoubleO商品体积m3IsReturnPrintTemplateStringO返回电子面单模板：0-不需要；1-需要IsSendMessageIntO是否订阅短信0-不需要；1-需要TemplateSizeStringO模板尺寸EBusinessIDStringR商户IDRequestTypeStringR请求指令类型：1007DataSignStringR数据内容签名DataTypeStringR请求、返回数据类型： 2-json1.3 返回结果参数l 同步返回参数名称类型必须要求说明EBusinessIDStringR电商用户IDOrderOrderCodeStringR订单编号ShipperCodeStringR快递公司编码LogisticCodeStringR快递单号MarkDestinationStringO大头笔OriginCodeStringO始发地区域编码OriginNameStringO始发地/始发网点DestinatioCodeStringO目的地区域编码DestinatioNameStringO目的地/到达网点SortingCodeStringO分拣编码PackageCodeStringO集包编码SuccessBoolR成功与否ResultCodeStringR错误编码ReasonStringO失败原因UniquerRequestNumberStringR唯一标识PrintTemplateStringO面单打印模板EstimatedDeliveryTimeStringO订单预计到货时间yyyy-mm-ddCallbackStringO用户自定义回调信息SubCountIntO子单数量SubOrdersStringO子单号SubPrintTemplatesStringO子单模板ReceiverSafePhoneStringO收件人安全电话SenderSafePhoneString0寄件人安全电话DialPageStringR拨号页面网址（转换成二维码可扫描拨号）2 接口对接demo2.1 PHP对接?php/电商IDdefined(EBusinessID) or define(EBusinessID, 请申请);/电商加密私钥，注意保管，不要泄漏defined(AppKey) or define(AppKey, 请申请 );/请求url，正式环境地址：http:/api.kdniao.cc/api/Eorderservice 测试环境地址：http:/testapi.kdniao.cc:8081/api/EOrderServicedefined(ReqURL) or define(ReqURL, http:/testapi.kdniao.cc:8081/api/Eorderservice);/构造电子面单提交信息$eorder = ;$eorderShipperCode = SF;$eorderOrderCode = 012657700387;$eorderPayType = 1;$eorderExpType = 1;$sender = ;$senderName = 李先生;$senderMobile =$senderProvinceName = 李先生;$senderCityName = 深圳市;$senderExpAreaName = 福田区;$senderAddress = 赛格广场5401AB;$receiver = ;$receiverName = 李先生;$receiverMobile =$receiverProvinceName = 李先生;$receiverCityName = 深圳市;$receiverExpAreaName = 福田区;$receiverAddress = 赛格广场5401AB;$commodityOne = ;$commodityOneGoodsName = 其他;$commodity = ;$commodity = $commodityOne;$eorderSender = $sender;$eorderReceiver = $receiver;$eorderCommodity = $commodity;/调用电子面单$jsonParam = json_encode($eorder, JSON_UNESCAPED_UNICODE);/$jsonParam = JSON($eorder);/兼容php5.2（含）以下echo 电子面单接口提交内容：.$jsonParam;$jsonResult = submitEOrder($jsonParam);echo 电子面单提交结果:.$jsonResult;/解析电子面单返回结果$result = json_decode($jsonResult, true);echo 返回码:.$resultResultCode;if($resultResultCode = 100) echo 是否成功:.$resultSuccess;else echo 电子面单下单失败;/-/* * Json方式 调用电子面单接口 */function submitEOrder($requestData)$datas = array( EBusinessID = EBusinessID, RequestType = 1007, RequestData = urlencode($requestData) , DataType = 2, ); $datasDataSign = encrypt($requestData, AppKey);$result=sendPost(ReqURL, $datas);/根据公司业务处理返回的信息.return $result; /* * post提交数据 * param string $url 请求Url * param array $datas 提交的数据 * return url响应返回的html */function sendPost($url, $datas) $temps = array(); foreach ($datas as $key = $value) $temps = sprintf(%s=%s, $key, $value); $post_data = implode(&, $temps); $url_info = parse_url($url);if(empty($url_infoport)$url_infoport=80; $httpheader = POST . $url_infopath . HTTP/1.0rn; $httpheader.= Host: . $url_infohost . rn; $httpheader.= Content-Type:application/x-www-form-urlencodedrn; $httpheader.= Content-Length: . strlen($post_data) . rn; $httpheader.= Connection:closernrn; $httpheader.= $post_data; $fd = fsockopen($url_infohost, $url_infoport); fwrite($fd, $httpheader); $gets = ;$headerFlag = true;while (!feof($fd) if ($header = fgets($fd) & ($header = rn | $header = n) break; while (!feof($fd) $gets.= fread($fd, 128); fclose($fd); return $gets;/* * 电商Sign签名生成 * param data 内容 * param appkey Appkey * return DataSign签名 */function encrypt($data, $appkey) return urlencode(base64_encode(md5($data.$appkey);/* * * 使用特定function对数组中所有元素做处理 * param string &$array 要处理的字符串 * param string $function 要执行的函数 * return boolean $apply_to_keys_also 是否也应用到key上 * access public * */ function arrayRecursive(&$array, $function, $apply_to_keys_also = false) static $recursive_counter = 0; if (+$recursive_counter 1000) die(possible deep recursion attack); foreach ($array as $key = $value) if (is_array($value) arrayRecursive($array$key, $function, $apply_to_keys_also); else $array$key = $function($value); if ($apply_to_keys_also & is_string($key) $new_key = $function($key); if ($new_key != $key) $array$new_key = $array$key; unset($array$key); $recursive_counter-; /* * * 将数组转换为JSON字符串（兼容中文） * param array $array 要转换的数组 * return string 转换得到的json字符串 * access public * */ function JSON($array) arrayRecursive($array, urlencode, true); $json = json_encode($array); return urldecode($json); ?2.2 C#对接using System;using System.Collections.Generic;using System.IO;using System.Linq;using System.Net;using System.Text;using System.Web;using System.Security.Cryptography.X509Certificates;using System.Net.Security;namespace Test public class KdApiEOrderDemo /电商ID private string EBusinessID = 请申请/reg; /电商加密私钥，注意保管，不要泄漏 private string AppKey = 请申请; /请求url /正式环境地址 / private string ReqURL = http:/api.kdniao.cc/api/Eorderservice; /测试环境地址 private string ReqURL = http:/testapi.kdniao.cc:8081/api/EOrderService; / / Json方式 电子面单 / / public string orderTracesSubByJson() string requestData = OrderCode: 012657700222, + ShipperCode:SF, + PayType:1, + ExpType:1, + Cost:1.0, + OtherCost:1.0, + Sender: + + Company:LV,Name:Taylor,MobileProvinceName:上海,CityName:上海,ExpAreaName:青浦区,Address:明珠路73号, + Receiver: + + Company:GCCUI,Name:Yann,MobileProvinceName:北京,CityName:北京,ExpAreaName:朝阳区,Address:三里屯街道雅秀大厦, + Commodity: + + GoodsName:鞋子,Goodsquantity:1,GoodsWeight:1.0, + Weight:1.0, + Quantity:1, + Volume:0.0, + Remark:小心轻放, + IsReturnPrintTemplate:1; Dictionary param = new Dictionary(); param.Add(RequestData, HttpUtility.UrlEncode(requestData, Encoding.UTF8); param.Add(EBusinessID, EBusinessID); param.Add(RequestType, 1007); string dataSign = encrypt(requestData, AppKey, UTF-8); param.Add(DataSign, HttpUtility.UrlEncode(dataSign, Encoding.UTF8); param.Add(DataType, 2); string result = sendPost(ReqURL, param); /根据公司业务处理返回的信息. return result; / / Post方式提交数据，返回网页的源代码 / / 发送请求的 URL / 请求的参数集合 / 远程资源的响应结果 private string sendPost(string url, Dictionary param) string result = ; StringBuilder postData = new StringBuilder(); if (param != null & param.Count 0) foreach (var p in param) if (postData.Length 0) postData.Append(&); postData.Append(p.Key); postData.Append(=); postData.Append(p.Value); 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.Message; return result; private bool CheckValidationResult(object sender, X509Certificate certificate, X509Chain chain, SslPolicyErrors sslPolicyErrors) throw new NotImplementedException(); / /电商Sign签名 / /内容 /Appkey /URL编码 /DataSign签名 private string encrypt(String content, String keyValue, String charset) if (keyValue != null) return base64(MD5(content + keyValue, charset), charset); return base64(MD5(content, charset), charset); / / 字符串MD5加密 / /要加密的字符串 /编码方式 /密文 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; / / base64编码 / / 内容 / 编码方式 / private string base64(String str, String charset) return Convert.ToBase64String(System.Text.Encoding.GetEncoding(charset).GetBytes(str); 2.3 .NET批量打印using System;using System.Collections.Generic;using System.Linq;using System.Text;using System.Web;using System.Web.UI;using System.Web.UI.WebControls;namespace KdniaoWebsite.WebUI.External public partial class PrintExample : System.Web.UI.Page /电商ID private string ID = ID; /电商加密私钥，注意保管，不要泄漏 private string AppKey = 需登录账号查询; protected void Page_Load(object sender, EventArgs e) if (!Page.IsPostBack) /OrderCode:客户需要打印的订单号，和调用快递鸟电子面单的订单号一致，PortName：本地打印机名称 var requestData = OrderCode:234351215333113311353,PortName:SF,OrderCode:234351215333113311354,PortName:打印机名称二; RequestData.Value = HttpUtility.UrlEncode(requestData, Encoding.UTF8); EBusinessID.Value = ID; DataSign.Value = Encrypt(GetIp() + requestData, AppKey, UTF-8); /是否预览，0-不