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

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

一.接口描述

(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)请求系统级参数

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

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

(2)请求内容字段定义

参数名称 类型 说明 是否必须
CallBack String 用户自定义回调信息 O
MemberID String 会员标识 O
CustomerName String 电子面单客户账号(与快递网点申请) O
CustomerPwd String 电子面单密码 O
SendSite String 收件网点标识 O
ShipperCode String 快递公司编码 R
LogisticCode String 快递单号 O
OrderCode String 订单编号 R
MonthCode String 月结编码 C
PayType Int 邮费支付方式:1-现付,2-到付,3-月结,4-第三方支付 R
ExpType String 快递类型:1-标准快件 R
IsNotice Int 是否通知快递员上门揽件:0-通知;1-不通知;不填则默认为0 O
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 上门取货时间段:"yyyy-MM-dd HH:mm:ss"格式化,本文中所有时间格式相同 O
EndDate String O
Weight Double 物品总重量kg O
Quantity Int 件数/包裹数 O
Volume Double 物品总体积m3 O
Remark String 备注 O
AddServices
AddService Name String 增值服务名称 O
Value String 增值服务值 O
CustomerID String 客户标识(选填) O
Commoditys
Commodity GoodsName String 商品名称 R
GoodsCode String 商品编码 O
Goodsquantity Int 商品数量 O
GoodsPrice Double 商品价格 O
GoodsWeight Double 商品重量kg O
GoodsDesc String 商品描述 O
GoodsVol Double 商品体积m3 O
IsReturnPrintTemplate String 返回电子面单模板:0-不需要;1-需要 O

(3)返回参数定义

参数名称 类型 说明 必须要求
EBusinessID String 用户ID R
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 订单预计到货时间yyyy-mm-dd O
Callback String 用户自定义回调信息 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();
    }
}
时间: 2024-10-05 20:25:37

免费圆通电子面单接口对接的相关文章

圆通电子面单接口对接及调试

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

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

电子面单是一种通过热敏纸打印输出纸质物流面单的物流服务.通过热感应显示文字,打印速度比传统针式打印速度提升4~6倍.电子面单以接口形式嵌入到自己的系统.网站上,可以在自己的平台操作打印电子面单. 1.接口描述 接口支持的消息接收方式:HTTPPOST 请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8" API地址:http://api.kdniao.cc/Ebusiness/EbusinessOrderH

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

一.电子面单接口类型及定义 1. 快递电子面单接口:快递公司自己开发的电子面单服务, 商家使用必须快递公司上门做系统对接,使用一家快递则需要对接一次. 2.菜鸟电子面单接口:可一次对接15家快递公司, 无需和每一家快递公司做对接.支持快递有四通一达.EMS.宅急送.德邦.优速.天天.快捷.全峰等15家常用快递公司,其中不包括顺丰. 3.快递鸟电子面单接口:可一次对接15家快递公司, 无需和每一家快递公司做对接.支持快递有四通一达.顺丰.EMS.宅急送.德邦.优速等15家快递公司,对顺丰有电子面单

快递鸟电子面单接口对接demo-JD京东物流

  1.注册账号http://www.kdniao.com/reg 2.在官网登录进入用户管理后台,进行实名认证,开通接口 3.技术对接及联调(登陆官网使用调试平台进行测试.) 4.上线   1.接口类型说明 1)接口支持的消息接收方式:HTTP POST 2)请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8" 3)API地址:http://api.kdniao.cc/Ebusiness/Ebusines

常用电子面单接口API及对接攻略(快递鸟、菜鸟、顺丰)

现在电商行业发展很快,很多企业订单量大,手写快递单比较慢,所以开通对接电子面单打印API接口就成了很多企业迫切需要的功能: 关于电子面单: 电子面单是一种通过热敏纸打印输出纸质物流面单的物流服务.通过热感应显示文字,打印速度比传统针式打印速度提升4~6倍.电子面单以接口形式嵌入到自己的系统.网站上,可以在自己的平台操作打印电子面单. 电子面单的应用主要包括电子面单接口和电子面单服务等内容,通过整合平台优化服务,可减少电子面单所受限制,使电子面单的应用更广泛使用更便捷优质.电子面单的单号是卖家向合

免费韵达电子面单接口类型及对接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.URLEn

电子面单批量打印接口对接(含打印控件)

现电商平台.打单工具.ERP 系统.WEB 端.APP 移动端等企业发货量较大,电子面单打印接口的需求也日益增加,现在给大家做一下梳理和使用方法介绍. 目前支持批量打印电子面单的有快递鸟.菜鸟和快递公司.但是快递公司仅能打印本公司的电子面单,对于电商等发货商来说不太适用,菜鸟教适合淘系商家,快递鸟则比较通用,这里介绍快递鸟电子面单接口批量打印的方法 对接流程: 快递鸟网站申请接口KEY-对接接口-调试-上线使用 接口支持: 顺丰(SF).EMS(EMS).宅急送(ZJS).圆通(YTO).百世快

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

顺丰速运快递查询接口API和电子面单接口怎么对接?除了通过顺丰自己的接口对接外,用的最多的就是第三方通过快递鸟对接了,通过顺丰单号和手机号后四位查询轨迹信息,如果是通过快递鸟下单获得的顺丰单号,可通过单号直接查询,具体下载快递鸟接口技术文档查看接口说明.ShipperCode为SF,且快递单号非快递鸟渠道返回时,必填,对应收件人/寄件人手机号后四位:ShipperCode为SF,且快递单号为快递鸟渠道返回时,不填. 一.接入前准备(TO商家业务人员) 1.申请快递鸟用户ID和API key1.1

快速实现常用快递单号查询api接口对接方法

网上的物流快递查询接口有很多,但是大部分都比较麻烦.所以这里介绍一个比较简单的查询方法,不需要对接友情链接,免费获取api接口技术文档以及demo 主要是利用 快递鸟的免费查询api接口: 快递鸟是全球最大的第三方快递物流接口服务商, 目前已经集成了418家快递单号查询接口,31家电子面单接口.高实时.高稳定.高并发,支持快递单号自动识别. 快递鸟第三方快递查询接口很好用,关键免费,使用的用户很多(有十几个千人技术QQ群),大的ERP基本都用的是快递鸟的接口,非淘系的电商平台也都是用快递鸟提供的