基于PHP的免費(fèi)快遞接口對(duì)接文檔

1、基于PHP的免費(fèi)快遞接口對(duì)接文檔1.1 在線下單接口1.1.1 接口規(guī)則 (1)、訂單編號(hào)(OrderCode)不可重復(fù)提交，重復(fù)提交系統(tǒng)會(huì)返回具體錯(cuò)誤代碼。 (2)、支持主流快遞公司在線下單，請(qǐng)聯(lián)系技術(shù)人員(聯(lián)系方式請(qǐng)看文檔尾部)。 (3)、接口只支持Json格式參數(shù)，接口指令1001。只支持POST請(qǐng)求方式，utf-8編碼。(4)、接口提供：快遞鳥(5)、支持增值服務(wù)，保價(jià)、代收貨款、貨款直退、貨款墊付等。(6)、測試地址：http:/testapi.kdniao.cc:8081/api/oorderservice/ 正式地址：http:/api.kdniao.cc/api/oorders

2、ervice1.1.2 系統(tǒng)級(jí)輸入?yún)?shù)參數(shù)名稱類型是否必須描述RequestDataStringR請(qǐng)求內(nèi)容，JSON格式,須和DataType一致EBusinessIDStringR電商IDRequestTypeStringR請(qǐng)求指令類型：1001 DataSignStringR數(shù)據(jù)內(nèi)容簽名DataTypeStringO請(qǐng)求、返回?cái)?shù)據(jù)類型：2-json；1.1.3 應(yīng)用級(jí)輸入?yún)?shù)參數(shù)名稱類型是否必須描述WarehouseIDStringO倉庫標(biāo)識(shí)(備用字段)WarehouseAddressStringO倉庫地址(備用字段)CallBackStringO商戶標(biāo)識(shí)(備用字段)MemberIDStr

3、ingO會(huì)員標(biāo)識(shí)(備用字段)ShipperCodeStringR快遞公司編碼LogisticCodeStringO快遞單號(hào)OrderCodeStringR訂單編號(hào)MonthCodeStringC月結(jié)編碼PayTypeIntR郵費(fèi)支付方式:1-現(xiàn)付，2-到付，3-月結(jié)，4-第三方支付ExpTypeIntR快遞類型：1-標(biāo)準(zhǔn)快件CostDoubleO寄件費(fèi)（運(yùn)費(fèi)）OtherCostDoubleO其他費(fèi)用ReceiverCompanyStringO收件人公司NameStringR收件人TelStringR電話與手機(jī)，必填一個(gè)MobileStringPostCodeStringO收件人郵編Provin

4、ceNameStringR收件?。ㄈ鐝V東省，不要缺少“省”）CityNameStringR收件市（如深圳市，不要缺少“市”）ExpAreaNameStringO收件區(qū)（如福田區(qū)，不要缺少“區(qū)”或“縣”）AddressStringR收件人詳細(xì)地址SenderCompanyStringO發(fā)件人公司NameStringR發(fā)件人TelStringR電話與手機(jī)，必填一個(gè)MobileStringPostCodeStringO發(fā)件人郵編ProvinceNameStringO發(fā)件?。ㄈ鐝V東省，不要缺少“省”）CityNameStringR發(fā)件市（如深圳市，不要缺少“市”）ExpAreaNameStringO發(fā)

5、件區(qū)（如福田區(qū)，不要缺少“區(qū)”或“縣”）AddressStringR發(fā)件詳細(xì)地址StartDateStringO上門取貨時(shí)間段:"yyyy-MM-dd HH:mm:ss"格式化，本文中所有時(shí)間格式相同EndDateStringOWeightDoubleO物品總重量kgQuantityIntO件數(shù)/包裹數(shù)VolumeDoubleO物品總體積m3RemarkStringO備注AddServiceNameString0增值服務(wù)名稱ValueString0增值服務(wù)值CustomerIDString0客戶標(biāo)識(shí)(選填)CommodityGoodsNameStringR商品名稱Goods

6、CodeStringO商品編碼GoodsquantityIntO件數(shù)GoodsPriceDoubleO商品價(jià)格GoodsWeightDoubleO商品重量kgGoodsDescStringO商品描述GoodsVolDoubleO商品體積m31.1.4 返回結(jié)果參數(shù)參數(shù)名稱類型必須要求說明EBusinessIDStringR電商用戶IDOrderOrderCodeStringR訂單編號(hào)ShipperCodeStringR快遞公司編碼LogisticCodeStringO快遞單號(hào)SuccessBoolR成功與否ResultCodeStringR結(jié)果編碼ReasonStringO失敗原因Unique

7、rRequestNumberStringR唯一標(biāo)識(shí)1.1.5 Json請(qǐng)求示例 "OrderCode": "012657018199", "ShipperCode": "SF", "PayType": 1, "MonthCode": "7553045845", "ExpType": 1, "Cost": 1.0, "OtherCost": 1.0, "Sender": &quo

8、t;Company": "LV", "Name": "Taylor", "Mobile": "quot;, "ProvinceName": "上海", "CityName": "上海", "ExpAreaName": "青浦區(qū)", "Address": "明珠路" , "Receiver": &

9、quot;Company": "GCCUI", "Name": "Yann", "Mobile": "quot;, "ProvinceName": "北京", "CityName": "北京", "ExpAreaName": "朝陽區(qū)", "Address": "三里屯街道" , "Commodity&q

10、uot;: "GoodsName": "鞋子", "Goodsquantity": 1, "GoodsWeight": 1.0 , "AddService": "Name": "COD", "Value": "1020" , "Weight": 1.0, "Quantity": 1, "Volume": 0.0, "Remark": &q

11、uot;小心輕放"1.1.6 Json請(qǐng)求返回示例 "EBusinessID": "1237100", "Success": true, "Order": "OrderCode": "012657018199", " ShipperCode ": " SF ", " LogisticCode ": "" , "ResultCode": "100",

12、 "Reason": ""1.2 取消訂單1.2.1 功能說明 物流公司還未指派業(yè)務(wù)員去取件的物流訂單可進(jìn)行取消操作，撤銷時(shí)需用戶填寫原因，填寫接口會(huì)通知物流公司取消訂單。1.2.2 接口規(guī)則 (1)、接口支持Json格式。 (2)、接口指令1004。1.2.3 系統(tǒng)級(jí)輸入?yún)?shù)參數(shù)名稱類型必須要求說明RequestDataStringR請(qǐng)求內(nèi)容，JSON格式,須和DataType一致EBusinessIDStringR電商IDRequestTypeStringR請(qǐng)求指令類型：1004DataSignStringR數(shù)據(jù)內(nèi)容簽名DataTypeStringO

13、請(qǐng)求、返回?cái)?shù)據(jù)類型： 2-json； 1.2.4 應(yīng)用級(jí)輸入?yún)?shù)參數(shù)名稱類型必須要求說明OrderCodeStringR訂單編號(hào)ShipperCodeStringR物流公司編碼LogisticCodeStringR物流單號(hào)1.2.5 返回結(jié)果參數(shù)參數(shù)名稱類型必須要求說明EBusinessIDStringR電商用戶IDOrderCodeStringR訂單編號(hào)ShipperCodeStringR快遞公司編碼LogisticCodeStringR快遞單號(hào)SuccessBoolR成功與否：true,falseReasonStringO失敗原因1.2.6 JSON請(qǐng)求示例 "OrderCode

14、": "201406240005", "ShipperCode": "ZJS", "LogisticCode": "118461988807"1.2.7 JSON返回示例 "EBusinessID": "1109259", "OrderCode": "201406240005", "ShipperCode": "ZJS", "LogisticCode&quo

15、t;: "118461988807", "Success": false, "Reason": " 訂單取消失敗"1.3 電子面單1.3.1 功能說明電子面單接口提供給獨(dú)立電商、倉儲(chǔ)管理系統(tǒng)、物流供應(yīng)鏈等物流系統(tǒng)平臺(tái)使用的下單接口，滿足客戶在線發(fā)貨需求并提供打印面單的服務(wù)，客戶通過網(wǎng)絡(luò)選擇物流公司發(fā)送請(qǐng)求通知有快遞要發(fā)貨，貴公司把數(shù)據(jù)通過此接口轉(zhuǎn)發(fā)，由接口通知對(duì)應(yīng)的快遞公司快遞員上門取件。電子面單成功下單后，接口系統(tǒng)內(nèi)將自動(dòng)訂閱，一旦軌跡發(fā)生變化時(shí)，接口將調(diào)用客戶方推送接收接口。同時(shí)若客戶使用代收貨款服務(wù)，接口會(huì)將

16、代收貨款的貨款狀態(tài)獨(dú)立推送給用戶。1.3.2 接口規(guī)則 (1)、只支持Json格式。接口指令1007。(2)、測試地址：http:/testapi.kdniao.cc:8081/api/eorderservice/(3)、正式地址：http:/api.kdniao.cc/api/EOrderService1.3.3 系統(tǒng)級(jí)輸入?yún)?shù)參數(shù)名稱類型必須要求說明RequestDataStringR請(qǐng)求內(nèi)容，JSON格式,須和DataType一致EBusinessIDStringR電商IDRequestTypeStringR請(qǐng)求指令類型：1007DataSignStringR數(shù)據(jù)內(nèi)容簽名DataType

17、StringO請(qǐng)求、返回?cái)?shù)據(jù)類型： 2-json 1.3.4 應(yīng)用級(jí)輸入?yún)?shù)參數(shù)名稱類型是否必須描述CallBackStringO用戶自定義回調(diào)信息MemberIDStringO會(huì)員標(biāo)識(shí)統(tǒng)一用戶標(biāo)識(shí)的商家IDCustomerNameStringO電子面單客戶賬號(hào)（與快遞網(wǎng)點(diǎn)申請(qǐng)）CustomerPwdStringO電子面單密碼SendSiteStringO收件網(wǎng)點(diǎn)標(biāo)識(shí)ShipperCodeStringR快遞公司編碼LogisticCodeStringO快遞單號(hào)OrderCodeStringR訂單編號(hào)MonthCodeStringC月結(jié)編碼PayTypeIntR郵費(fèi)支付方式:1-現(xiàn)付，2-到付，

18、3-月結(jié)，4-第三方支付ExpTypeStringR快遞類型：1-標(biāo)準(zhǔn)快件IsNoticeIntO是否通知快遞員上門攬件：0-通知；1-不通知；不填則默認(rèn)為0CostDoubleO寄件費(fèi)（運(yùn)費(fèi)）OtherCostDoubleO其他費(fèi)用ReceiverCompanyStringO收件人公司NameStringR收件人TelStringR電話與手機(jī)，必填一個(gè)MobileStringPostCodeStringO收件人郵編ProvinceNameStringR收件?。ㄈ鐝V東省，不要缺少“省”）CityNameStringR收件市（如深圳市，不要缺少“市”）ExpAreaNameStringO收件區(qū)（

19、如福田區(qū)，不要缺少“區(qū)”或“縣”）AddressStringR收件人詳細(xì)地址SenderCompanyStringO發(fā)件人公司NameStringR發(fā)件人TelStringR電話與手機(jī)，必填一個(gè)MobileStringPostCodeStringO發(fā)件人郵編ProvinceNameStringR發(fā)件?。ㄈ鐝V東省，不要缺少“省”）CityNameStringR發(fā)件市（如深圳市，不要缺少“市”）ExpAreaNameStringO發(fā)件區(qū)（如福田區(qū)，不要缺少“區(qū)”或“縣”）AddressStringR發(fā)件詳細(xì)地址StartDateStringO上門取貨時(shí)間段:"yyyy-MM-dd HH:

20、mm:ss"格式化，本文中所有時(shí)間格式相同EndDateStringOWeightDoubleO物品總重量kgQuantityIntO件數(shù)/包裹數(shù)VolumeDoubleO物品總體積m3RemarkStringO備注AddServiceNameString0增值服務(wù)名稱ValueString0增值服務(wù)值CustomerIDString0客戶標(biāo)識(shí)(選填)CommodityGoodsNameStringR商品名稱GoodsCodeStringO商品編碼GoodsquantityIntO件數(shù)GoodsPriceDoubleO商品價(jià)格GoodsWeightDoubleO商品重量kgGoods

21、DescStringO商品描述GoodsVolDoubleO商品體積m3IsReturnPrintTemplateStringO返回電子面單模板：0-不需要；1-需要1.3.5 返回結(jié)果參數(shù)l 同步返回參數(shù)名稱類型必須要求說明EBusinessIDStringR電商用戶IDOrderOrderCodeStringR訂單編號(hào)ShipperCodeStringR快遞公司編碼LogisticCodeStringR快遞單號(hào)MarkDestinationStringO大頭筆OriginCodeStringO始發(fā)地區(qū)域編碼OriginNameStringO始發(fā)地/始發(fā)網(wǎng)點(diǎn)DestinatioCodeStr

22、ingO目的地區(qū)域編碼DestinatioNameStringO目的地/到達(dá)網(wǎng)點(diǎn)SortingCodeStringO分揀編碼PackageCodeStringO集包編碼SuccessBoolR成功與否ResultCodeStringR錯(cuò)誤編碼ReasonStringO失敗原因UniquerRequestNumberStringR唯一標(biāo)識(shí)PrintTemplateStringO面單打印模板EstimatedDeliveryTimeStringO訂單預(yù)計(jì)到貨時(shí)間yyyy-mm-ddCallbackStringO用戶自定義回調(diào)信息1.4 增值服務(wù)列表名稱代碼說明備注代收貨款CODValue 為貨款，

23、保留3 位小數(shù)。CustomerID 為代收貨款卡號(hào)保價(jià)INSUREvalue 為聲明價(jià)值，保留3 位小數(shù)注：使用接口代收貨款服務(wù)，需申請(qǐng)接口的代收貨款服務(wù)，填寫用于還款的銀行卡號(hào)等信息。1.5 調(diào)用demo（PHP）1.5.1 電子面單demo<?php/* * * 電子面單接口 * ID和Key請(qǐng)到官網(wǎng)申請(qǐng)： */電商IDdefined('EBusinessID') or define('EBusinessID', '請(qǐng)申請(qǐng)/電商加密私鑰，注意保管，不要泄漏defined('AppKey') or define('App

24、Key', '請(qǐng)申請(qǐng)/請(qǐng)求url，接口正式地址：http:/api.kdniao.cc/api/Eorderservicedefined('ReqURL') or define('ReqURL', 'http:/testapi.kdniao.cc:8081/api/Eorderservice');/調(diào)用獲取物流軌跡/-/構(gòu)造電子面單提交信息$eorder = ;$eorder"ShipperCode" = "SF"$eorder"OrderCode" = "PM

25、201604062341"$eorder"PayType" = 1;$eorder"ExpType" = 1;$sender = ;$sender"Name" = "李先生"$sender"Mobile" = "quot;$sender"ProvinceName" = "李先生"$sender"CityName" = "深圳市"$sender"ExpAreaNam

26、e" = "福田區(qū)"$sender"Address" = "賽格廣場5401AB"$receiver = ;$receiver"Name" = "李先生"$receiver"Mobile" = "quot;$receiver"ProvinceName" = "李先生"$receiver"CityName" = "深圳市"$receiver"Ex

27、pAreaName" = "福田區(qū)"$receiver"Address" = "賽格廣場5401AB"$commodityOne = ;$commodityOne"GoodsName" = "其他"$commodity = ;$commodity = $commodityOne;$eorder"Sender" = $sender;$eorder"Receiver" = $receiver;$eorder"Commodity"

28、= $commodity;/調(diào)用電子面單$jsonParam = json_encode($eorder, JSON_UNESCAPED_UNICODE);/$jsonParam = JSON($eorder);/兼容php5.2（含）以下echo "電子面單接口提交內(nèi)容：<br/>".$jsonParam;$jsonResult = submitEOrder($jsonParam);echo "<br/><br/>電子面單提交結(jié)果:<br/>".$jsonResult;/解析電子面單返回結(jié)果$result

29、 = json_decode($jsonResult, true);echo "<br/><br/>返回碼:".$result"ResultCode"if($result"ResultCode" = "100") echo "<br/>是否成功:".$result"Success"else echo "<br/>電子面單下單失敗"/-/* * Json方式 查詢訂單物流軌跡 */function submit

30、EOrder($requestData)$datas = array( 'EBusinessID' => EBusinessID, 'RequestType' => '1007', 'RequestData' => urlencode($requestData) , 'DataType' => '2', ); $datas'DataSign' = encrypt($requestData, AppKey);$result=sendPost(ReqURL, $d

31、atas);/根據(jù)公司業(yè)務(wù)處理返回的信息.return $result; /* * post提交數(shù)據(jù) * param string $url 請(qǐng)求Url * param array $datas 提交的數(shù)據(jù) * return url響應(yīng)返回的html */function sendPost($url, $datas) $temps = array(); foreach ($datas as $key => $value) $temps = sprintf('%s=%s', $key, $value); $post_data = implode('&'

32、;, $temps); $url_info = parse_url($url);if($url_info'port'='')$url_info'port'=80;echo $url_info'port' $httpheader = "POST " . $url_info'path' . " HTTP/1.0rn" $httpheader.= "Host:" . $url_info'host' . "rn" $httphe

33、ader.= "Content-Type:application/x-www-form-urlencodedrn" $httpheader.= "Content-Length:" . strlen($post_data) . "rn" $httpheader.= "Connection:closernrn" $httpheader.= $post_data; $fd = fsockopen($url_info'host', $url_info'port'); fwrite($fd,

34、$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 內(nèi)容 * param appkey Appkey * return D

35、ataSign簽名 */function encrypt($data, $appkey) return urlencode(base64_encode(md5($data.$appkey);/* * * 使用特定function對(duì)數(shù)組中所有元素做處理 * param string &$array 要處理的字符串 * param string $function 要執(zhí)行的函數(shù) * return boolean $apply_to_keys_also 是否也應(yīng)用到key上 * access public * */ function arrayRecursive(&$array, $

36、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($

37、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-; /* * * 將數(shù)組轉(zhuǎn)換為JSON字符串（兼容中文） * param array $array 要轉(zhuǎn)換的數(shù)組 * return string 轉(zhuǎn)換得到的json字符串 * access public * */ function JSON($ar

38、ray) arrayRecursive($array, 'urlencode', true); $json = json_encode($array); return urldecode($json); ?>1.5.2 在線下單demo<?php/電商IDdefined('EBusinessID') or define('EBusinessID', 1237100);/電商加密私鑰，注意保管，不要泄漏defined('AppKey') or define('AppKey', '518a73d8-

39、1f7f-441a-b644-33e77b49d846');/請(qǐng)求urldefined('ReqURL') or define('ReqURL', 'http:/api.kdniao.cc/Ebusiness/EbusinessOrderHandle.aspx');/* * Json方式 在線下單 */function orderOnlineByJson()$requestData="'LogisticsWeight':2.0,"."'LogisticsVol':2.0,&qu

40、ot;."'HQPOrderDesc':'盡快上門收件,PHP demo測試',"."'HQPPayType':1,"."'IsNeedPay':2,"."'Payment':121.0,"."'OrderCode':'test_12345674',"."'StartDate':'2015-05-13 21:20:53',".&quo

41、t;'EndDate':'2015-05-14 21:20:53',"."'ShipperCode':'LB',"."'LogisticCode':'109932607391',"."'ToCompany':'華為科技',"."'ToName':'張三',"."'ToAddressArea':'深圳市南山區(qū)桂廟路5

42、55號(hào)',"."'ToTel':'',"."'ToMobile':'#39;,"."'OrderType':2,"."'ToPostCode':'518128',"."'ToProvinceID':'廣東省',"."'ToCityID':'深圳市',"."&#

43、39;ToExpAreaID':'南山區(qū)',"."'FromCompany':'小米科技',"."'FromName':'李四',"."'FromAddressArea':'深圳市福田區(qū)華強(qiáng)北路222號(hào)',"."'FromTel':'88888888',"."'FromMobile':'',"."

44、;'FromPostCode':'529800',"."'FromProvinceID':'廣東省',"."'FromCityID':'深圳市',"."'FromExpAreaID':'福田區(qū)',"."'Cost':21.0,"."'OtherCost':2.0,"."'Commoditys':&quo

45、t;.""."'Goodsquantity':12,"."'GoodsName':'手機(jī)屏幕',"."'GoodsCode':'kjyhu878787',"."'GoodsPrice':121.0"."" $datas = array( 'EBusinessID' => EBusinessID, 'RequestType' => '

46、;1001', 'RequestData' => urlencode($requestData) , 'DataType' => '2', ); $datas'DataSign' = encrypt($requestData, AppKey);$result=sendPost(ReqURL, $datas);/根據(jù)公司業(yè)務(wù)處理返回的信息.return $result;/* * XML方式 在線下單 */function orderOnlineByXml()$requestData= "<?xml

47、 version="1.0" encoding="utf-8" ?>"."<Content>"."<LogisticsWeight>1.5</LogisticsWeight>"."<OrderCode>test_123456</OrderCode>"."<LogisticsVol>0.5</LogisticsVol>"."<HQPOrderDesc>測試在

48、線下單接口 20150510</HQPOrderDesc>"."<HQPPayType>1</HQPPayType>"."<IsNeedPay>1</IsNeedPay>"."<Payment>1000</Payment>"."<OrderType>1</OrderType>"."<StartDate>2015-05-10 19:36:50</StartDate>&

49、quot;."<EndDate>2015-05-11 19:36:50</EndDate>"."<ShipperCode>LB</ShipperCode>"."<LogisticCode></LogisticCode>"."<ToName>張三</ToName>"."<ToAddressArea>深圳市南山區(qū)南新路2055號(hào)</ToAddressArea>"."<

50、;ToTel></ToTel>"."<ToMobile>lt;/ToMobile>"."<ToPostCode></ToPostCode>"."<ToProvinceID>廣東省</ToProvinceID>"."<ToCityID>深圳市</ToCityID>"."<ToExpAreaID>南山區(qū)</ToExpAreaID>".&

51、quot;<FromCompany>科技</FromCompany>"."<FromName>李四</FromName>"."<FromAddressArea>深圳市福田區(qū)華強(qiáng)北路211號(hào)</FromAddressArea>"."<FromTel></FromTel>"."<FromMobile>lt;/FromMobile>"."<FromPostCo

52、de></FromPostCode>"."<FromProvinceID>廣東省</FromProvinceID>"."<FromCityID>深圳市</FromCityID>"."<FromExpAreaID>福田區(qū)</FromExpAreaID>"."<Cost>12</Cost>"."<OtherCost>1</OtherCost>"."<Commoditys>"."<Commodity>"."<GoodsName>惠普顯示器</GoodsName>"."<GoodsCode>ABCD_123456789</GoodsCode>"."<Goodsquantity>2</Goodsquantity>".&qu