免费圆通电子面单接口对接

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了免费圆通电子面单接口对接相关的知识,希望对你有一定的参考价值。

    电子面单接口是快递鸟提供给独立电商、仓储管理系统、物流供应链等物流系统平台使用的下单接口,满足客户在线发货需求并提供打印面单的服务,客户通过网络选择物流公司发送请求通知贵公司有快递要发货,把数据通过此接口转发到快递鸟,由快递鸟为您通知对应的快递公司快递员上门取件。电子面单成功下单后,快递鸟系统内将自动订阅,一旦轨迹发生变化时,快递鸟将调用客户方推送接收接口。同时若客户使用代收货款服务,快递鸟会将代收货款的货款状态独立推送给用户。

    

一.接口描述

(1)订单编号(OrderCode)不可重复提交,重复提交系统会返回具体错误代码。
(2)接口支持的消息接收方式为HTTP POST,请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。

(3)接口地址:

    API测试地址:http://testapi.kdniao.cc:8081/api/EOrderService
    API正式地址:http://api.kdniao.cc/api/EOrderService

(4)圆通编码:YTO


二.接口参数

(1)请求系统级参数


参数名称类型说明必须要求
RequestDataString请求内容需进行URL(utf-8)编码。请求内容JSON格式,须和DataType一致。R
EBusinessIDString商户ID,请在我的服务页面查看。R
RequestTypeString请求指令类型:1007R
DataSignString数据内容签名:把(请求内容(未编码)+AppKey)进行MD5加密,然后Base64编码,最后进行URL(utf-8)编码。详细过程请查看Demo。R
DataTypeString请求、返回数据类型:只支持JSON格式O


备注:R-必填(Required),O-可选(Optional),C-报文中该参数在一定条件下可选(Conditional)。


(2)请求内容字段定义


参数名称类型说明是否必须
CallBackString用户自定义回调信息O
MemberIDString会员标识O
CustomerNameString电子面单客户账号(与快递网点申请)O
CustomerPwdString电子面单密码O
SendSiteString收件网点标识O
ShipperCodeString快递公司编码R
LogisticCodeString快递单号O
OrderCodeString订单编号R
MonthCodeString月结编码C
PayTypeInt邮费支付方式:1-现付,2-到付,3-月结,4-第三方支付R
ExpTypeString快递类型:1-标准快件R
IsNoticeInt是否通知快递员上门揽件:0-通知;1-不通知;不填则默认为0O
CostDouble寄件费(运费)O
OtherCostDouble其他费用O
ReceiverCompanyString收件人公司O
NameString收件人R
TelString电话与手机,必填一个R
MobileString
PostCodeString收件人邮编O
ProvinceNameString收件省(如广东省,不要缺少“省”)R
CityNameString收件市(如深圳市,不要缺少“市”)R
ExpAreaNameString收件区(如福田区,不要缺少“区”或“县”)O
AddressString收件人详细地址R
SenderCompanyString发件人公司O
NameString发件人R
TelString电话与手机,必填一个R
MobileString
PostCodeString发件人邮编O
ProvinceNameString发件省(如广东省,不要缺少“省”)R
CityNameString发件市(如深圳市,不要缺少“市”)R
ExpAreaNameString发件区(如福田区,不要缺少“区”或“县”)O
AddressString发件人详细地址R
StartDateString上门取货时间段:"yyyy-MM-dd HH:mm:ss"格式化,本文中所有时间格式相同O
EndDateStringO
WeightDouble物品总重量kgO
QuantityInt件数/包裹数O
VolumeDouble物品总体积m3O
RemarkString备注O
AddServices
AddServiceNameString增值服务名称O
ValueString增值服务值O
CustomerIDString客户标识(选填)O
Commoditys
CommodityGoodsNameString商品名称R
GoodsCodeString商品编码O
GoodsquantityInt商品数量O
GoodsPriceDouble商品价格O
GoodsWeightDouble商品重量kgO
GoodsDescString商品描述O
GoodsVolDouble商品体积m3O
IsReturnPrintTemplateString返回电子面单模板:0-不需要;1-需要O


(3)返回参数定义

参数名称类型说明必须要求
EBusinessIDString用户IDR
OrderOrderCodeString订单编号R
ShipperCodeString快递公司编码R
LogisticCodeString快递单号R
MarkDestinationString大头笔O
OriginCodeString始发地区域编码O
OriginNameString始发地/始发网点O
DestinatioCodeString目的地区域编码O
DestinatioNameString目的地/到达网点O
SortingCodeString分拣编码O
PackageCodeString集包编码O
SuccessBool成功与否R
ResultCodeString错误编码R
ReasonString失败原因O
UniquerRequestNumberString唯一标识R
PrintTemplateString面单打印模板O
EstimatedDeliveryTimeString订单预计到货时间yyyy-mm-ddO
CallbackString用户自定义回调信息O



三.接口对接demo

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://www.kdniao.com/ServiceApply.aspx";	
	//电商加密私钥,快递鸟提供,注意保管,不要泄漏
	private String AppKey="请到快递鸟官网申请http://www.kdniao.com/ServiceApply.aspx";	
	//请求url, 正式环境地址:http://api.kdniao.cc/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‘:‘YTO‘," +
                "‘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();
    }
}


以上是关于免费圆通电子面单接口对接的主要内容,如果未能解决你的问题,请参考以下文章

各种电子面单Api接口-免费对接

圆通电子面单接口申请案例(PHP)

免费顺丰快递单号查询电子面单api接口对接快递鸟API

免费韵达电子面单接口类型及对接demo

顺丰电子面单api接口怎么接入?

常用电子面单接口对接技术文档