电商适用电子面单接口对接案例

Posted 2020-10-12

电子面单接口现在有快递公司、菜鸟和快递鸟提供

快递公司是一家家合作，要接口文档，逐一对接

菜鸟和快递鸟是电子面单接口集成方，能打印多家快递电子面单，菜鸟目前支持15家，快递鸟支持20家，基本上都是常用的快递，以下接口对接以快递鸟接口为例

 

在对接前需要到快递鸟网站注册账号，才能得到自己的接口ID和秘钥

 

对接规则：

(1)、只支持Json格式。接口指令1007。

(2)、订单编号(OrderCode)不可重复提交，重复提交系统会返回具体错误代码。

(3)、目前接口支持了：顺丰（SF）、EMS（EMS）、宅急送（ZJS）、圆通（YTO）、百世快递（HTKY）、中通（ZTO）、韵达（YD）、申通（STO）、德邦（DBL）、优速（UC）、京东（JD）、信丰（XFEX）、全峰（QFKD）、跨越速运（KYSY）、安能小包（ANE）、快捷快递（FAST）、国通（GTO）、天天快递（HHTT）、邮政快递包裹（YZPY），后续更多的快递公司正在对接中。

 散户模式（无需电子面单客户号）支持快递公司：顺丰（SF）、EMS（EMS）（仅支持广东省内发货）、快捷快递（FAST）、宅急送（ZJS）、邮政快递包裹（YZPY），后续更多的快递公司正在对接中。

(4)、请求报文中不允许出现以下特殊字符： ‘   "   #    &    +    <   >

 

系统级及应用级输入参数

系统级输入参数	应用级输入参数			类型	是否必须	描述
RequestData（必填参数，请求内容，JSON格式,须和DataType一致）	CallBack			String	O	用户自定义回调信息
	MemberID			String	O	会员标识 平台方与快递鸟统一用户标识的商家ID
	CustomerName			String	O	电子面单客户账号 （与快递网点申请或通过快递鸟官网申请或通过申请电子面单客户号申请）
	CustomerPwd			String	O	电子面单密码
	SendSite			String	O	收件网点标识
	ShipperCode			String	R	快递公司编码
	LogisticCode			String	O	快递单号
	ThrOrderCode			String	O	第三方订单号
	OrderCode			String	R	订单编号
	MonthCode			String	C	月结编码
	PayType			Int	R	邮费支付方式: 1-现付，2-到付，3-月结，4-第三方支付
	ExpType			String	R	快递类型：1-标准快件
	IsNotice			Int	O	是否通知快递员上门揽件：0-通知；1-不通知；不填则默认为1
	Cost			Double	O	寄件费（运费）
	OtherCost			Double	O	其他费用
	Receiver	Company		String	O	收件人公司
		Name		String	R	收件人
		Tel		String	R	电话与手机，必填一个
		Mobile		String
		PostCode		String	O	收件人邮编
		ProvinceName		String	R	收件省（如广东省，不要缺少“省”）
		CityName		String	R	收件市（如深圳市，不要缺少“市”）
		ExpAreaName		String	O	收件区（如福田区，不要缺少“区”或“县”）
		Address		String	R	收件人详细地址
	Sender	Company		String	O	发件人公司
		Name		String	R	发件人
		Tel		String	R	电话与手机，必填一个
		Mobile		String
		PostCode		String	O	发件人邮编
		ProvinceName		String	R	发件省（如广东省，不要缺少“省”）
		CityName		String	R	发件市（如深圳市，不要缺少“市”）
		ExpAreaName		String	O	发件区（如福田区，不要缺少“区”或“县”）
		Address		String	R	发件详细地址
	StartDate			String	O	上门取货时间段: "yyyy-MM-dd HH:mm:ss"格式化，本文中所有时间格式相同
	EndDate			String	O
	Weight			Double	O	物品总重量kg
	Quantity			Int	O	件数/包裹数
	Volume			Double	O	物品总体积m3
	Remark			String	O	备注
	AddService		Name	String	0	增值服务名称
			Value	String	0	增值服务值
			CustomerID	String	0	客户标识(选填)
	Commodity		GoodsName	String	R	商品名称
			GoodsCode	String	O	商品编码
			Goodsquantity	Int	O	件数
			GoodsPrice	Double	O	商品价格
			GoodsWeight	Double	O	商品重量kg
			GoodsDesc	String	O	商品描述
			GoodsVol	Double	O	商品体积m3
	IsReturnPrintTemplate			String	O	返回电子面单模板： 0-不需要；1-需要
	IsSendMessage			Int	O	是否订阅短信 0-不需要；1-需要
	TemplateSize			String	O	模板尺寸
EBusinessID				String	R	商户ID
RequestType				String	R	请求指令类型：1007
DataSign				String	R	数据内容签名
DataType				String	R	请求、返回数据类型： 2-json

 

同步返回参数

参数名称		类型	必须要求	说明
EBusinessID		String	R	电商用户ID
Order	OrderCode	String	R	订单编号
	ShipperCode	String	R	快递公司编码
	LogisticCode	String	R	快递单号
	MarkDestination	String	O	大头笔
	OriginCode	String	O	始发地区域编码
	OriginName	String	O	始发地/始发网点
	DestinatioCode	String	O	目的地区域编码
	DestinatioName	String	O	目的地/到达网点
	SortingCode	String	O	分拣编码
	PackageCode	String	O	集包编码
Success		Bool	R	成功与否
ResultCode		String	R	错误编码
Reason		String	O	失败原因
UniquerRequestNumber		String	R	唯一标识
PrintTemplate		String	O	面单打印模板
EstimatedDeliveryTime		String	O	订单预计到货时间yyyy-mm-dd
Callback		String	O	用户自定义回调信息
SubCount		Int	O	子单数量
SubOrders		String	O	子单号
SubPrintTemplates		String	O	子单模板
ReceiverSafePhone		String	O	收件人安全电话
SenderSafePhone		String	0	寄件人安全电话
DialPage		String	R	拨号页面网址（转换成二维码可扫描拨号）

 

单次打印-JAVA

import java.io.BufferedReader;
import java.io.IOException; 
import java.io.InputStreamReader;
import java.io.OutputStreamWriter;
import java.io.UnsupportedEncodingException;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;
import java.util.HashMap;
import java.util.Map;
import com.sun.org.apache.xerces.internal.impl.dv.util.Base64;
import java.security.MessageDigest; 


 
public class KdGoldAPIDemo {
	
	//电商ID
	private String EBusinessID="请申请http://kdniao.com/reg";	
	//电商加密私钥，注意保管，不要泄漏
	private String AppKey="请申请";	
	//请求url, 正式环境地址：http://api.kdniao.cc/api/Eorderservice    测试环境地址：http://testapi.kdniao.cc:8081/api/EOrderService
	private String ReqURL="http://testapi.kdniao.cc:8081/api/Eorderservice";	
	

	/**
     * Json方式 电子面单
	 * @throws Exception 
     */
	public String orderOnlineByJson() throws Exception{
		String requestData= "{‘OrderCode‘: ‘012657700387‘," +
                "‘ShipperCode‘:‘SF‘," +
                "‘PayType‘:1," +
                "‘ExpType‘:1," +
                "‘Cost‘:1.0," +
                "‘OtherCost‘:1.0," +
                "‘Sender‘:" +
                "{" +
                "‘Company‘:‘LV‘,‘Name‘:‘Taylor‘,‘Mobile‘:‘15018442396‘,‘ProvinceName‘:‘上海‘,‘CityName‘:‘上海‘,‘ExpAreaName‘:‘青浦区‘,‘Address‘:‘明珠路73号‘}," +
                "‘Receiver‘:" +
                "{" +
                "‘Company‘:‘GCCUI‘,‘Name‘:‘Yann‘,‘Mobile‘:‘15018442396‘,‘ProvinceName‘:‘北京‘,‘CityName‘:‘北京‘,‘ExpAreaName‘:‘朝阳区‘,‘Address‘:‘三里屯街道雅秀大厦‘}," +
                "‘Commodity‘:" +
                "[{" +
                "‘GoodsName‘:‘鞋子‘,‘Goodsquantity‘:1,‘GoodsWeight‘:1.0}]," +
                "‘Weight‘:1.0," +
                "‘Quantity‘:1," +
                "‘Volume‘:0.0," +
                "‘Remark‘:‘小心轻放‘," +
                "‘IsReturnPrintTemplate‘:1}";
		Map<String, String> params = new HashMap<String, String>();
		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 = result[i] & 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 UnsupportedEncodingException{
		String encoded = Base64.encode(str.getBytes(charset));
		return encoded;    
	}	
	
	@SuppressWarnings("unused")
	private String urlEncoder(String str, String charset) throws UnsupportedEncodingException{
		String 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, Exception
	{
		if (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<String, String> 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<String, String> 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();
    }
}