电子面单接口API对接文档.docxVIP

电子面单接口API对接文档1 电子面单接口(1)、接口申请：快递鸟网站注册申请接口API(2)、订单编号(OrderCode)不可重复提交，重复提交系统会返回具体错误代码。(3)、目前接口支持了：顺丰（SF）、EMS（EMS）、宅急送（ZJS）、圆通（YTO）、百世快递（HTKY）、中通（ZTO）、韵达（YD）、申通（STO）等20家常用快递电子面单。(4)、请求报文中不允许出现以下特殊字符： # & + 2 电子面单余量查询接口2.1 功能说明用户查询客户号在快递公司的单号剩余量。2.2 接口规则(1) 、接口只支持Json格式参数，接口指令1127。只支持POST请求方式，utf-8编码。(2) 、目前支持快递公司：优速，中通，韵达，后续更多的快递公司正在对接中。 2.3 系统级和应用级输入参数系统级输入参数类型应用级输入参数必须要求描述RequestData（必填参数，请求内容，JSON格式,须和DataType一致）StringShipperCodeR快递公司编码StringCustomerNameR电子面单账号StringCustomerPwdO电子面单密码StringStationCodeO网点编码StringStationNameO网点EBusinessIDStringR电商IDRequestTypeStringR请求指令类型：1127DataSignStringR数据内容签名DataTypeStringR请求、返回数据类型： 2-json；2.4 返回结果参数参数名称类型必须要求说明EbusinessIDStringR用户IDSuccessBoolR成功与否：true,falseReasonStringO原因ResultCodeStringR返回结果编号EorderBalanceTotalNumIntO累计充值数量，电子面单总量(包含已使用/未使用)AvailableNumIntO可用量(剩余量)2.5 JSON请求示例 ShipperCode: UC, CustomerName: 80238728, CustomerPwd: c0bfe0ba86b66bae5426303c53db0a81, StationCode: 3001, StationName: 福田网点2.6 JSON返回示例 EBusinessID: 1261602, Success: true, Reason: , ResultCode: 100, EorderBalance: AvailableNum: 0, TotalNum: 0 3 电子面单单号取消3.1 功能说明快递鸟通用接口提交快递公司编码、快递单号，则可以取消提交单号。仅支持未揽件状态快递单进行取消，取消后的回收规则以快递公司为准。3.2 接口规则(1) 、接口指令1147。(2) 、目前支持快递公司：优速，后续更多的快递公司正在对接中。3.3 系统级和应用级输入参数系统级输入参数类型应用级输入参数必须要求描述RequestData（必填参数，请求内容，JSON格式,须和DataType一致）StringShipperCodeR快递公司编码StringExpNoR运单号StringCustomerNameR客户号StringCustomerPwdO客户号密码EBusinessIDStringR电商IDRequestTypeStringR请求指令类型：1147DataSignStringR数据内容签名DataTypeStringR请求、返回数据类型： 2-json；3.4 返回结果参数参数名称类型必须要求说明EbusinessIDStringR用户IDSuccessBoolR成功与否：true,falseResultCodeStringO结果编码ReasonStringO原因3.5 Json请求示例 ShipperCode: UC, ExpNo: 900008664480, CustomerName: 80238728, CustomerPwd: c0bfe0ba86b66bae5426303c53db0a8b3.6 Json请求返回示例 EBusinessID: 1261602, Success: true, ResultCode: 1004 申请电子面单客户号4.1 功能说明客户通过快递鸟平台向快递公司申请客户号4.2 接口规则(1)、接口只支持Json格式参数，接口指令1107。只支持POST请求方式，utf-8编码。 (2)、测试地址：http:/testapi.kdniao.cc:8081 /api/apiservice(3) 、正式地址：http:/api.kdniao.cc /api/apiservice(4) 、目前支持快递公司：优速，后续更多的快递公司正在对接中。4.3 系统级和应用级输入参数系统级输入参数类型应用级输入参数必须要求描述RequestData（必填参数，请求内容，JSON格式,须和DataType一致）stringShipperCodeR快递公司编码StationCodeR网点编码StationNameR网点ApplyIDO申请ID（用户记录在快递公司的标识）CompanyO公司NameR联系人TelC电话MobileC手机ProvinceNameR省份ProivnceCodeO省编码CityNameR城市CityCodeO城市编码ExpAreaNameR区县ExpAreaCodeO区县编码AddressR详细地址EBusinessIDStringR电商IDRequestTypeStringR请求指令类型：1107DataSignStringR数据内容签名DataTypeStringR请求、返回数据类型： 2-json；4.4 返回结果参数参数名称类型是否必须描述EbusinessIDStringR用户IDSuccessBoolR成功与否：true,falseResultCodeStringO结果编码ReasonStringO原因4.5 Json请求示例 ShipperCode: UC, Company: XXX, ApplyID: 1261602, Name: hoo123, Tel: 07558812345, Mobile: ProvinceName: 广东省, ProivnceCode: 440000, CityName: 深圳市, CityCode: 440300, ExpAreaName: 宝安区, ExpAreaCode: 440306, Address: 西乡, StationCode: 西乡网点, StationName: 西乡网点4.6 Json请求返回示例 EBusinessID: 1261602, Success: true, Reason: 提交申请成功, ResultCode: 1005 接口对接demo5.1 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; public class KdGoldAPIDemo /电商IDprivate String EBusinessID= ;/电商加密私钥，注意保管，不要泄漏private String AppKey= ;/请求url, 正式环境地址：http:/api.kdniao.cc/api/Eorderservice 测试环境地址：http:/testapi.kdniao.cc:8081/api/EOrderServiceprivate String ReqURL=http:/testapi.kdniao.cc:8081/api/Eorderservice;/* * Json方式 电子面单 * throws Exception */public String orderOnlineByJson() throws ExceptionString requestData= OrderCode: 012657700387, + 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;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(); 5.2 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); ?5.3 JAVA批量打印package cc.kdniao.api;import java.io.IOException;import java.io.PrintWriter;import java.io.UnsupportedEncodingException;import .URLEncoder;import java.security.MessageDigest;import javax.servlet.ServletException;import javax.servlet.annotation.WebServlet;import javax.servlet.http.HttpServlet;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import ernal.messaging.saaj.util.Base64;/* * Servlet implementation class printOrder */WebServlet(/printOrder)public class printOrder extends HttpServlet private static final long serialVersionUID = 1L; final String EBussinessID = ;/ EBusinessID final String AppKey = ; / AppKey final Integer IsPreview = 0; /是否预览 0-不预览 1-预览 /* * see HttpServlet#HttpServlet() */ public printOrder() super(); / TODO Auto-generated constructor stub /* * see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response) */ protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException / TODO Auto-generated method stub /response.getWriter().append(Served at: ).append(request.getContextPath(); PrintWriter print = response.getWriter(); String jsonResult = ; try String ip = getIpAddress(request); jsonResult = getPrintParam(ip); catch (Exception e) /write log print.println(jsonResult); print.flush(); print.close(); /* * see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response) */ protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException, UnsupportedEncodingException / TODO Auto-generated method stub response.setContentType(); PrintWriter print = response.getWriter(); String jsonResult = ; try String ip = getIpAddress(request); jsonResult = getPrintParam(ip); catch (Exception e) /wirte log print.println(jsonResult); print.flush(); print.close(); /* * get print order param to json string * return * * throws Exception */ private String getPrintParam(String ip) th