圆通快递电子面单接口对接说明.docx

圆通快递电子面单接口对接说明（全）1.接口类型说明1）接口支持的消息接收方式：HTTP POST2）请求方法的编码格式(utf-8)：application/x-www-form-urlencoded;charset=utf-83）API地址：http:/api.kdniao.cc/Ebusiness/EbusinessOrderHandle.aspx4）接口提供：快递鸟5）快递编码：YTO2.请求系统级参数参数名称类型说明必须要求RequestDataString请求内容需进行URL(utf-8)编码。请求内容JSON格式，须和DataType一致。REBusinessIDString商户ID，请在我的服务页面查看。RRequestTypeString请求指令类型：1007RDataSignString数据内容签名：把(请求内容(未编码)+AppKey)进行MD5加密，然后Base64编码，最后进行URL(utf-8)编码。详细过程请查看Demo。RDataTypeString请求、返回数据类型：只支持JSON格式O备注：R-必填（Required），O-可选（Optional），C-报文中该参数在一定条件下可选（Conditional）。3.接口参数1）请求内容字段定义参数名称类型说明是否必须CallBackString用户自定义回调信息OMemberIDString会员标识OCustomerNameString电子面单客户账号（与快递网点申请）OCustomerPwdString电子面单密码OSendSiteString收件网点标识OShipperCodeString快递公司编码RLogisticCodeString快递单号OOrderCodeString订单编号RMonthCodeString月结编码CPayTypeInt邮费支付方式:1-现付，2-到付，3-月结，4-第三方支付RExpTypeString快递类型：1-标准快件RIsNoticeInt是否通知快递员上门揽件：0-通知；1-不通知；不填则默认为0OCostDouble寄件费（运费）OOtherCostDouble其他费用OReceiverCompanyString收件人公司ONameString收件人RTelString电话与手机，必填一个RMobileStringPostCodeString收件人邮编OProvinceNameString收件省（如广东省，不要缺少“省”）RCityNameString收件市（如深圳市，不要缺少“市”）RExpAreaNameString收件区（如福田区，不要缺少“区”或“县”）OAddressString收件人详细地址RSenderCompanyString发件人公司ONameString发件人RTelString电话与手机，必填一个RMobileStringPostCodeString发件人邮编OProvinceNameString发件省（如广东省，不要缺少“省”）RCityNameString发件市（如深圳市，不要缺少“市”）RExpAreaNameString发件区（如福田区，不要缺少“区”或“县”）OAddressString发件人详细地址RStartDateString上门取货时间段:yyyy-MM-dd HH:mm:ss格式化，本文中所有时间格式相同OEndDateStringOWeightDouble物品总重量kgOQuantityInt件数/包裹数OVolumeDouble物品总体积m3ORemarkString备注OAddServicesAddServiceNameString增值服务名称OValueString增值服务值OCustomerIDString客户标识（选填）OCommoditysCommodityGoodsNameString商品名称RGoodsCodeString商品编码OGoodsquantityInt商品数量OGoodsPriceDouble商品价格OGoodsWeightDouble商品重量kgOGoodsDescString商品描述OGoodsVolDouble商品体积m3OIsReturnPrintTemplateString返回电子面单模板：0-不需要；1-需要O2）返回参数定义参数名称类型说明必须要求EBusinessIDString用户IDROrderOrderCodeString订单编号RShipperCodeString快递公司编码RLogisticCodeString快递单号RMarkDestinationString大头笔OOriginCodeString始发地区域编码OOriginNameString始发地/始发网点ODestinatioCodeString目的地区域编码ODestinatioNameString目的地/到达网点OSortingCodeString分拣编码OPackageCodeString集包编码OSuccessBool成功与否RResultCodeString错误编码RReasonString失败原因OUniquerRequestNumberString唯一标识RPrintTemplateString面单打印模板OEstimatedDeliveryTimeString订单预计到货时间yyyy-mm-ddOCallbackString用户自定义回调信息O4. 示例1）JSON请求示例OrderCode:012657700387,ShipperCode:HTKY,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,AddService: Name:COD,Value:1020,Weight: 1.0,Quantity: 1,Volume: 0.0,Remark:小心轻放,IsReturnPrintTemplate:12）JSON返回示例失败：EBusinessID:1237100,ResultCode:105,Reason:订单号已存在，请勿重复操作，UniquerRequestNumber:5e66486b-8fbc-4131-b875-9b13d2ad1354成功：EBusinessID:1237100,Order: OrderCode:012657700387,ShipperCode:HTKY,LogisticCode:50002498503427,MarkDestination:京-朝阳(京-1),OriginCode:200000,OriginName:上海分拨中心,PackageCode:北京,PrintTemplate:此处省略打印模板HTML内容,EstimatedDeliveryTime:2016-03-06,Callback:调用时传入的Callback,Success:true,ResultCode:100,Reason:成功5.JAVA对接源码import java.io.BufferedReader;import java.io.IOException; import java.io.InputStreamReader;import java.io.OutputStreamWriter;import java.io.UnsupportedEncodingException;import .HttpURLConnection;import .URL;import .URLEncoder;import java.util.HashMap;import java.util.Map;import ernal.impl.dv.util.Base64;import java.security.MessageDigest; /* * ID和Key请到官网申请：/ServiceApply.aspx */ public class KdGoldAPIDemo /电商IDprivate String EBusinessID=ID请申请;/电商加密私钥，注意保管，不要泄漏private String AppKey=KEY请申请;/请求url, 正式环境地址：http:/api.kdniao.cc/api/Eorderserviceprivate String ReqURL=http:/testapi.kdniao.cc:8081/api/Eorderservice;/* * Json方式 电子面单 * throws Exception */public String orderOnlineByJson() throws ExceptionString requestData= OrderCode: 118060839871, + ShipperCode:HHTT, + 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;Map params = new HashMap();params.put(RequestData, urlEncoder(requestData, UTF-8);params.put(EBusinessID, EBusinessID);params.put(RequestType, 1007);String dataSign=encrypt(requestData, AppKey, UTF-8);params.put(DataSign, urlEncoder(dataSign, UTF-8);params.put(DataType, 2);String result=sendPost(ReqURL, params);/根据公司业务处理返回的信息.return result;/* * MD5加密 * param str 内容 * param charset 编码方式 * throws Exception */SuppressWarnings(unused)private String MD5(String str, String charset) throws Exception MessageDigest md = MessageDigest.getInstance(MD5); md.update(str.getBytes(charset); byte result = md.digest(); StringBuffer sb = new StringBuffer(32); for (int i = 0; i result.length; i+) int val = resulti & 0xff; if (val = 0xf) sb.append(0); sb.append(Integer.toHexString(val); return sb.toString().toLowerCase();/* * base64编码 * param str 内容 * param charset 编码方式 * throws UnsupportedEncodingException */private String base64(String str, String charset) throws UnsupportedEncodingExceptionString encoded = Base64.encode(str.getBytes(charset);return encoded; SuppressWarnings(unused)private String urlEncoder(String str, String charset) throws UnsupportedEncodingExceptionString result = URLEncoder.encode(str, charset);return result;/* * 电商Sign签名生成 * param content 内容 * param keyValue Appkey * param charset 编码方式 * throws UnsupportedEncodingException ,Exception * return DataSign签名 */SuppressWarnings(unused)private String encrypt (String content, String keyValue, String charset) throws UnsupportedEncodingException, Exceptionif (keyValue != null)return base64(MD5(content + keyValue, charset), charset);return base64(MD5(content, charset), charset); /* * 向指定 URL 发送POST方法的请求 * param url 发送请求的 URL * param params 请求的参数集合 * return 远程资源的响应结果 */SuppressWarnings(unused)private String sendPost(String url, Map params) OutputStreamWriter out = null; BufferedReader in = null; StringBuilder result = new StringBuilder(); try URL realUrl = new URL(url); HttpURLConnection conn =(HttpURLConnection) realUrl.openConnection(); / 发送POST请求必须设置如下两行 conn.setDoOutput(true); conn.setDoInput(true); / POST方法 conn.setRequestMethod(POST); / 设置通用的请求属性 conn.setRequestProperty(accept, */*); conn.setRequestProperty(connection, Keep-Alive); conn.setRequestProperty(user-agent, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1;SV1); conn.setRequestProperty(Content-Type, application/x-www-form-urlencoded); conn.connect(); / 获取URLConnection对象对应的输出流 out = new OutputStreamWriter(conn.getOutputStream(), UTF-8); / 发送请求参数 if (params != null) StringBuilder param = new StringBuilder(); for (Map.Entry entry : params.entrySet() if(param.length()0) param.append(&); param.append(entry.getKey(); param.append(=); param.append(entry.getValue(); System.out.println(entry.getKey()+:+entry.getValue(); System.out.println(param:+param.toString(); out.write(param.toString(); / flush输出流的缓冲 out.flush(); / 定义BufferedReader输入流来读取URL的响应 in = new BufferedReader( new InputStreamReader(conn.getInputStream(), UTF-8); String line; while (line = in.readLine() != null) result.append(line); catch (Exception e) e.printStackTrace(); /使用finally块来关闭输出流、输入流 finally try if(out!=null) out.close(); if(in!=null) in.close(); catch(IOException ex) ex.printStackTrace(); return result.toString(); 6.PHP对接源码?php/电商IDdefined(EBusinessID) or define(EBusinessID, 请申请/ServiceApply.aspx);/电商加密私钥，注意保管，不要泄漏defined(AppKey) or define(AppKey, 请申请/ServiceApply.aspx);/请求url，接口正式地址：http:/api.kdniao.cc/api/Eorderservicedefined(ReqURL) or define(ReqURL, http:/testapi.kdniao.cc:8081/api/Eorderservice);/调用获取物流轨迹/-/构造电子面单提交信息$eorder = ;$eorderShipperCode = HHTT;$eorderOrderCode = PM201604062341;$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($url_infoport=)$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.= $post_data; $fd = fsockopen($url_infohost, $url_infoport); fwrite($fd, $httpheader); $gets = ;$headerFlag = true;while (!feof($fd) if ($header = fgets($fd) & ($header = rn |