基于PHP的免费快递接口对接文档

1、基于PHP的免费快递接口对接文档1.1 在线下单接口1.1.1 接口规则 (1)、订单编号(OrderCode)不可重复提交，重复提交系统会返回具体错误代码。 (2)、支持主流快递公司在线下单，请联系技术人员(联系方式请看文档尾部)。 (3)、接口只支持Json格式参数，接口指令1001。只支持POST请求方式，utf-8编码。(4)、接口提供：快递鸟(5)、支持增值服务，保价、代收货款、货款直退、货款垫付等。(6)、测试地址：http:/testapi.kdniao.cc:8081/api/oorderservice/ 正式地址：http:/api.kdniao.cc/api/oorders

2、ervice1.1.2 系统级输入参数参数名称类型是否必须描述RequestDataStringR请求内容，JSON格式,须和DataType一致EBusinessIDStringR电商IDRequestTypeStringR请求指令类型：1001 DataSignStringR数据内容签名DataTypeStringO请求、返回数据类型：2-json；1.1.3 应用级输入参数参数名称类型是否必须描述WarehouseIDStringO仓库标识(备用字段)WarehouseAddressStringO仓库地址(备用字段)CallBackStringO商户标识(备用字段)MemberIDStr

3、ingO会员标识(备用字段)ShipperCodeStringR快递公司编码LogisticCodeStringO快递单号OrderCodeStringR订单编号MonthCodeStringC月结编码PayTypeIntR邮费支付方式:1-现付，2-到付，3-月结，4-第三方支付ExpTypeIntR快递类型：1-标准快件CostDoubleO寄件费（运费）OtherCostDoubleO其他费用ReceiverCompanyStringO收件人公司NameStringR收件人TelStringR电话与手机，必填一个MobileStringPostCodeStringO收件人邮编Provin

4、ceNameStringR收件省（如广东省，不要缺少“省”）CityNameStringR收件市（如深圳市，不要缺少“市”）ExpAreaNameStringO收件区（如福田区，不要缺少“区”或“县”）AddressStringR收件人详细地址SenderCompanyStringO发件人公司NameStringR发件人TelStringR电话与手机，必填一个MobileStringPostCodeStringO发件人邮编ProvinceNameStringO发件省（如广东省，不要缺少“省”）CityNameStringR发件市（如深圳市，不要缺少“市”）ExpAreaNameStringO发

5、件区（如福田区，不要缺少“区”或“县”）AddressStringR发件详细地址StartDateStringO上门取货时间段:yyyy-MM-dd HH:mm:ss格式化，本文中所有时间格式相同EndDateStringOWeightDoubleO物品总重量kgQuantityIntO件数/包裹数VolumeDoubleO物品总体积m3RemarkStringO备注AddServiceNameString0增值服务名称ValueString0增值服务值CustomerIDString0客户标识(选填)CommodityGoodsNameStringR商品名称GoodsCodeStringO商

6、品编码GoodsquantityIntO件数GoodsPriceDoubleO商品价格GoodsWeightDoubleO商品重量kgGoodsDescStringO商品描述GoodsVolDoubleO商品体积m31.1.4 返回结果参数参数名称类型必须要求说明EBusinessIDStringR电商用户IDOrderOrderCodeStringR订单编号ShipperCodeStringR快递公司编码LogisticCodeStringO快递单号SuccessBoolR成功与否ResultCodeStringR结果编码ReasonStringO失败原因UniquerRequestNumb

7、erStringR唯一标识1.1.5 Json请求示例 OrderCode: 012657018199, ShipperCode: SF, PayType: 1, MonthCode: 7553045845, ExpType: 1, Cost: 1.0, OtherCost: 1.0, Sender: Company: LV, Name: Taylor, Mobile: ProvinceName: 上海, CityName: 上海, ExpAreaName: 青浦区, Address: 明珠路 , Receiver: Company: GCCUI, Name: Yan

8、n, Mobile: ProvinceName: 北京, CityName: 北京, ExpAreaName: 朝阳区, Address: 三里屯街道 , Commodity: GoodsName: 鞋子, Goodsquantity: 1, GoodsWeight: 1.0 , AddService: Name: COD, Value: 1020 , Weight: 1.0, Quantity: 1, Volume: 0.0, Remark: 小心轻放1.1.6 Json请求返回示例 EBusinessID: 1237100, Success: true, Orde

9、r: OrderCode: 012657018199, ShipperCode : SF , LogisticCode : , ResultCode: 100, Reason: 1.2 取消订单1.2.1 功能说明 物流公司还未指派业务员去取件的物流订单可进行取消操作，撤销时需用户填写原因，填写接口会通知物流公司取消订单。1.2.2 接口规则 (1)、接口支持Json格式。 (2)、接口指令1004。1.2.3 系统级输入参数参数名称类型必须要求说明RequestDataStringR请求内容，JSON格式,须和DataType一致EBusinessIDStringR电商IDRequestTy

10、peStringR请求指令类型：1004DataSignStringR数据内容签名DataTypeStringO请求、返回数据类型： 2-json； 1.2.4 应用级输入参数参数名称类型必须要求说明OrderCodeStringR订单编号ShipperCodeStringR物流公司编码LogisticCodeStringR物流单号1.2.5 返回结果参数参数名称类型必须要求说明EBusinessIDStringR电商用户IDOrderCodeStringR订单编号ShipperCodeStringR快递公司编码LogisticCodeStringR快递单号SuccessBoolR成功与否：t

11、rue,falseReasonStringO失败原因1.2.6 JSON请求示例 OrderCode: 201406240005, ShipperCode: ZJS, LogisticCode: 1184619888071.2.7 JSON返回示例 EBusinessID: 1109259, OrderCode: 201406240005, ShipperCode: ZJS, LogisticCode: 118461988807, Success: false, Reason: 订单取消失败1.3 电子面单1.3.1 功能说明电子面单接口提供给独立电商、仓储管理系统、物流供应链等物流系统平台使

12、用的下单接口，满足客户在线发货需求并提供打印面单的服务，客户通过网络选择物流公司发送请求通知有快递要发货，贵公司把数据通过此接口转发，由接口通知对应的快递公司快递员上门取件。电子面单成功下单后，接口系统内将自动订阅，一旦轨迹发生变化时，接口将调用客户方推送接收接口。同时若客户使用代收货款服务，接口会将代收货款的货款状态独立推送给用户。1.3.2 接口规则 (1)、只支持Json格式。接口指令1007。(2)、测试地址：http:/testapi.kdniao.cc:8081/api/eorderservice/(3)、正式地址：http:/api.kdniao.cc/api/EOrderSer

13、vice1.3.3 系统级输入参数参数名称类型必须要求说明RequestDataStringR请求内容，JSON格式,须和DataType一致EBusinessIDStringR电商IDRequestTypeStringR请求指令类型：1007DataSignStringR数据内容签名DataTypeStringO请求、返回数据类型： 2-json 1.3.4 应用级输入参数参数名称类型是否必须描述CallBackStringO用户自定义回调信息MemberIDStringO会员标识统一用户标识的商家IDCustomerNameStringO电子面单客户账号（与快递网点申请）CustomerP

14、wdStringO电子面单密码SendSiteStringO收件网点标识ShipperCodeStringR快递公司编码LogisticCodeStringO快递单号OrderCodeStringR订单编号MonthCodeStringC月结编码PayTypeIntR邮费支付方式:1-现付，2-到付，3-月结，4-第三方支付ExpTypeStringR快递类型：1-标准快件IsNoticeIntO是否通知快递员上门揽件：0-通知；1-不通知；不填则默认为0CostDoubleO寄件费（运费）OtherCostDoubleO其他费用ReceiverCompanyStringO收件人公司NameS

15、tringR收件人TelStringR电话与手机，必填一个MobileStringPostCodeStringO收件人邮编ProvinceNameStringR收件省（如广东省，不要缺少“省”）CityNameStringR收件市（如深圳市，不要缺少“市”）ExpAreaNameStringO收件区（如福田区，不要缺少“区”或“县”）AddressStringR收件人详细地址SenderCompanyStringO发件人公司NameStringR发件人TelStringR电话与手机，必填一个MobileStringPostCodeStringO发件人邮编ProvinceNameStringR发

16、件省（如广东省，不要缺少“省”）CityNameStringR发件市（如深圳市，不要缺少“市”）ExpAreaNameStringO发件区（如福田区，不要缺少“区”或“县”）AddressStringR发件详细地址StartDateStringO上门取货时间段:yyyy-MM-dd HH:mm:ss格式化，本文中所有时间格式相同EndDateStringOWeightDoubleO物品总重量kgQuantityIntO件数/包裹数VolumeDoubleO物品总体积m3RemarkStringO备注AddServiceNameString0增值服务名称ValueString0增值服务值Cust

17、omerIDString0客户标识(选填)CommodityGoodsNameStringR商品名称GoodsCodeStringO商品编码GoodsquantityIntO件数GoodsPriceDoubleO商品价格GoodsWeightDoubleO商品重量kgGoodsDescStringO商品描述GoodsVolDoubleO商品体积m3IsReturnPrintTemplateStringO返回电子面单模板：0-不需要；1-需要1.3.5 返回结果参数l 同步返回参数名称类型必须要求说明EBusinessIDStringR电商用户IDOrderOrderCodeStringR订单编

18、号ShipperCodeStringR快递公司编码LogisticCodeStringR快递单号MarkDestinationStringO大头笔OriginCodeStringO始发地区域编码OriginNameStringO始发地/始发网点DestinatioCodeStringO目的地区域编码DestinatioNameStringO目的地/到达网点SortingCodeStringO分拣编码PackageCodeStringO集包编码SuccessBoolR成功与否ResultCodeStringR错误编码ReasonStringO失败原因UniquerRequestNumberStr

19、ingR唯一标识PrintTemplateStringO面单打印模板EstimatedDeliveryTimeStringO订单预计到货时间yyyy-mm-ddCallbackStringO用户自定义回调信息1.4 增值服务列表名称代码说明备注代收货款CODValue 为货款，保留3 位小数。CustomerID 为代收货款卡号保价INSUREvalue 为声明价值，保留3 位小数注：使用接口代收货款服务，需申请接口的代收货款服务，填写用于还款的银行卡号等信息。1.5 调用demo（PHP）1.5.1 电子面单demo?php/* * * 电子面单接口 * ID和Key请到官网申请： */电商

20、IDdefined(EBusinessID) or define(EBusinessID, 请申请/电商加密私钥，注意保管，不要泄漏defined(AppKey) or define(AppKey, 请申请/请求url，接口正式地址：http:/api.kdniao.cc/api/Eorderservicedefined(ReqURL) or define(ReqURL, http:/testapi.kdniao.cc:8081/api/Eorderservice);/调用获取物流轨迹/-/构造电子面单提交信息$eorder = ;$eorderShipperCode = SF;$eorder

21、OrderCode = PM201604062341;$eorderPayType = 1;$eorderExpType = 1;$sender = ;$senderName = 李先生;$senderMobile =$senderProvinceName = 李先生;$senderCityName = 深圳市;$senderExpAreaName = 福田区;$senderAddress = 赛格广场5401AB;$receiver = ;$receiverName = 李先生;$receiverMobile =$receiverProvi

22、nceName = 李先生;$receiverCityName = 深圳市;$receiverExpAreaName = 福田区;$receiverAddress = 赛格广场5401AB;$commodityOne = ;$commodityOneGoodsName = 其他;$commodity = ;$commodity = $commodityOne;$eorderSender = $sender;$eorderReceiver = $receiver;$eorderCommodity = $commodity;/调用电子面单$jsonParam = json_encode($eord

23、er, 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;el

24、se 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 $

25、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($url_infoport=

26、)$url_infoport=80;echo $url_infoport; $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.=

27、$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 内容 * par

28、am 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 arrayR

29、ecursive(&$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($

30、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) arra

31、yRecursive($array, urlencode, true); $json = json_encode($array); return urldecode($json); ?1.5.2 在线下单demo EBusinessID, RequestType = 1001, RequestData = urlencode($requestData) , DataType = 2, ); $datasDataSign = encrypt($requestData, AppKey);$result=sendPost(ReqURL, $datas);/根据公司业务处理返回的信息.return $

32、result;/* * XML方式 在线下单 */function orderOnlineByXml()$requestData= .1.5.test_123456.0.5.测试在线下单接口 201505000.1.2015-05-10 19:36:50.2015-05-11 19:36:50.LB.张三.深圳市南山区南新路2055号广东省.深圳市.南山区.科技.李四.深圳市福田区华强北路211号广东省.深圳市.福田区.12.1.惠普显示器.ABCD_123456789.2.850.神州笔记本.QWERT_456456.2.4200.;$datas = arra