各种电子面单-Api接口(顺丰、快递鸟、菜鸟)
目錄術(shù)語電子面單樣式對(duì)接接口各家對(duì)比各家合作流程對(duì)比接口定義及說明Request Params系統(tǒng)級(jí)參數(shù)(公共參數(shù))接口參數(shù)Response ParamsJava栗子
術(shù)語
對(duì)于一般人,電子面單的意思可能并不是很了解;說白了,就是快遞員給你打印的快遞單的電子版。
專業(yè)解釋:
電子面單是一種通過熱敏紙打印輸出紙質(zhì)物流面單的物流服務(wù)。通過熱感應(yīng)顯示文字,打印速度比傳統(tǒng)針式打印速度提升4~6倍。電子面單以接口形式嵌入到自己的系統(tǒng)、網(wǎng)站上,可以在自己的平臺(tái)操作打印電子面單。
電子面單樣式
對(duì)接接口各家對(duì)比
快遞電子面單接口:快遞公司自己開發(fā)的電子面單服務(wù), 商家使用必須快遞公司上門做系統(tǒng)對(duì)接,使用一家快遞則需要對(duì)接一次。
菜鳥電子面單接口:可一次對(duì)接15家快遞公司, 無需和每一家快遞公司做對(duì)接。支持快遞有四通一達(dá)、EMS、宅急送、德邦、優(yōu)速、天天、快捷、全峰等15家常用快遞公司,其中不包括順豐。
快遞鳥電子面單接口:可一次對(duì)接15家快遞公司, 無需和每一家快遞公司做對(duì)接。支持快遞有四通一達(dá)、順豐、EMS、宅急送、德邦、優(yōu)速等15家快遞公司,對(duì)順豐有電子面單服務(wù)需求的可以選擇順豐自有的電子面單或者是快遞鳥電子面單。
各家合作流程對(duì)比
快遞電子面單接口
a. 和多家快遞公司申請(qǐng)賬號(hào)
b.分別進(jìn)行接口對(duì)接
c.電子面單服務(wù)用戶向快遞網(wǎng)點(diǎn)申請(qǐng)開通及確認(rèn)合作細(xì)節(jié)
菜鳥電子面單
a.向菜鳥網(wǎng)絡(luò)提交對(duì)接申請(qǐng)
b.和菜鳥進(jìn)行接口對(duì)接
c.電子面單服務(wù)用戶向菜鳥申請(qǐng)賬號(hào)
d.電子面單服務(wù)用戶向快遞網(wǎng)點(diǎn)申請(qǐng)開通及確認(rèn)合作細(xì)節(jié)
快遞鳥電子面單
a. 進(jìn)入申請(qǐng)賬號(hào),獲取專屬的ID和KEY
b.和快遞鳥進(jìn)行接口對(duì)接
c.電子面單服務(wù)用戶向快遞網(wǎng)點(diǎn)申請(qǐng)開通及確認(rèn)合作細(xì)節(jié);當(dāng)然,順豐電子面單稍微特殊一點(diǎn),即:順豐接入快遞鳥立馬可以使用,無需注冊(cè)賬號(hào)。
接口定義及說明
由于,當(dāng)前快遞鳥支持的電子面單接口相對(duì)于其他家的有一定優(yōu)勢(shì);所以以下主要以快遞鳥為例進(jìn)行展開闡述一一說明。
Request Params
Api接口:http://api.kdniao.cc/Ebusiness/EbusinessOrderHandle.aspx
請(qǐng)求方式:POST
編碼:UTF-8
系統(tǒng)級(jí)參數(shù)(公共參數(shù))
| 參數(shù)名稱 | 類型 | 說明 | 是否必需 |
|---|---|---|---|
| RequestData | String | 請(qǐng)求內(nèi)容需進(jìn)行URL(utf-8)編碼。請(qǐng)求內(nèi)容JSON格式,須和DataType一致 | R |
| EBusinessID | String | 商戶ID,請(qǐng)?jiān)谖业姆?wù)頁面查看 | R |
| RequestType | String | 請(qǐng)求指令類型:1007 | R |
| DataSign | String | 數(shù)據(jù)內(nèi)容簽名:把(請(qǐng)求內(nèi)容(未編碼)+AppKey)進(jìn)行MD5加密,然后Base64編碼,最后進(jìn)行URL(utf-8)編碼。詳細(xì)過程請(qǐng)查看Demo | R |
| DataType | String | 請(qǐng)求、返回?cái)?shù)據(jù)類型:只支持JSON格式 | O |
備注:R-必填(Required),O-可選(Optional),C-報(bào)文中該參數(shù)在一定條件下可選(Conditional)。
接口參數(shù)
| 參數(shù)名稱 | 類型 | 說明 | 是否必需 |
|---|---|---|---|
| CallBack | String | 用戶自定義回調(diào)信息 | O |
| MemberID | String | 會(huì)員標(biāo)識(shí) | O |
| CustomerName | String | 電子面單客戶賬號(hào)(與快遞網(wǎng)點(diǎn)申請(qǐng)) | O |
| CustomerPwd | String | 電子面單密碼 | O |
| SendSite | String | 收件網(wǎng)點(diǎn)標(biāo)識(shí) | O |
| ShipperCode | String | 快遞公司編碼 | R |
| LogisticCode | String | 快遞單號(hào) | O |
| OrderCode | String | 訂單編號(hào) | R |
| MonthCode | String | 月結(jié)編碼 | C |
| PayType | Int | 郵費(fèi)支付方式:1-現(xiàn)付,2-到付,3-月結(jié),4-第三方支付 | R |
| ExpType | String | 快遞類型:1-標(biāo)準(zhǔn)快件 | R |
| Cost | Double | 寄件費(fèi)(運(yùn)費(fèi)) | O |
| OtherCost | Double | 其他費(fèi)用 | O |
| StartDate | String | 上門取貨時(shí)間段:"yyyy-MM-dd HH:mm:ss"格式化,本文中所有時(shí)間格式相同 | O |
| EndDate | String | 上門取貨時(shí)間段:"yyyy-MM-dd HH:mm:ss"格式化,本文中所有時(shí)間格式相同 | O |
| Weight | Double | 物品總重量kg | O |
| Quantity | Int | 件數(shù)/包裹數(shù) | O |
| Volume | Double | 物品總體積m3 | O |
| Remark | String | 備注 | O |
| IsReturnPrintTemplate | String | 返回電子面單模板:0-不需要;1-需要 | O |
| Receiver | Company | String | 收件人公司 | O |
|---|---|---|---|---|
| Name | String | 收件人 | R | |
| Tel | String | 電話與手機(jī),必填一個(gè) | R | |
| Mobile | String | 電話與手機(jī),必填一個(gè) | R | |
| PostCode | String | 收件人郵編 | O | |
| ProvinceName | String | 收件省(如廣東省,不要缺少“省”) | R | |
| CityName | String | 收件市(如深圳市,不要缺少“市”) | R | |
| ExpAreaName | String | 收件區(qū)(如福田區(qū),不要缺少“區(qū)”或“縣”) | O | |
| Address | String | 收件人詳細(xì)地址 | R |
| Sender | Company | String | 發(fā)件人公司 | O |
|---|---|---|---|---|
| Name | String | 收件人 | R | |
| Tel | String | 電話與手機(jī),必填一個(gè) | R | |
| Mobile | String | 電話與手機(jī),必填一個(gè) | R | |
| PostCode | String | 發(fā)件人郵編 | O | |
| ProvinceName | String | 發(fā)件省(如廣東省,不要缺少“省”) | R | |
| CityName | String | 發(fā)件市(如深圳市,不要缺少“市”) | R | |
| ExpAreaName | String | 發(fā)件區(qū)(如福田區(qū),不要缺少“區(qū)”或“縣”) | O | |
| Address | String | 發(fā)件人詳細(xì)地址 | R |
| AddServices | ||||
|---|---|---|---|---|
| AddService | Name | String | 增值服務(wù)名稱 | O |
| Value | String | 增值服務(wù)值 | O | |
| CustomerID | String | 客戶標(biāo)識(shí)(選填) | O |
| Commoditys | ||||
|---|---|---|---|---|
| Commodity | GoodsName | String | 商品名稱 | R |
| GoodsCode | String | 商品編碼 | O | |
| Goodsquantity | String | 商品數(shù)量 | O | |
| GoodsPrice | String | 商品價(jià)格 | O | |
| GoodsWeight | String | 商品重量kg | O | |
| GoodsDesc | String | 商品描述 | O | |
| GoodsVol | String | 商品體積m3 | O |
Response Params
| 參數(shù)名稱 | 類型 | 說明 | 是否必需 |
|---|---|---|---|
| EBusinessID | String | 用戶ID | R |
| Success | Bool | 成功與否 | R |
| ResultCode | String | 錯(cuò)誤編碼 | R |
| Reason | String | 失敗原因 | O |
| UniquerRequestNumber | String | 唯一標(biāo)識(shí) | R |
| PrintTemplate | String | 面單打印模板 | O |
| EstimatedDeliveryTime | String | 訂單預(yù)計(jì)到貨時(shí)間yyyy-mm-dd | O |
| Callback | String | 用戶自定義回調(diào)信息 | O |
| Order | OrderCode | String | 訂單編號(hào) | R |
|---|---|---|---|---|
| ShipperCode | String | 快遞公司編碼 | R | |
| LogisticCode | String | 快遞單號(hào) | R | |
| MarkDestination | String | 大頭筆 | O | |
| OriginCode | String | 始發(fā)地區(qū)域編碼 | O | |
| OriginName | String | 始發(fā)地/始發(fā)網(wǎng)點(diǎn) | O | |
| DestinatioCode | String | 目的地區(qū)域編碼 | O | |
| DestinatioName | String | 目的地/到達(dá)網(wǎng)點(diǎn) | O | |
| SortingCode | String | 分揀編碼 | O | |
| PackageCode | String | 集包編碼 | O |
Java栗子
注:此栗子僅供參考,如要使用請(qǐng)到官方下載對(duì)應(yīng)語言的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;
/**
*
* 快遞鳥電子面單接口
*
* @技術(shù)QQ: 4009633321
* @技術(shù)QQ群: 200121393
* @see: http://www.kdniao.com/MiandanAPI.aspx
* @copyright: 深圳市快金數(shù)據(jù)技術(shù)服務(wù)有限公司
*
* ID和Key請(qǐng)到官網(wǎng)申請(qǐng):http://www.kdniao.com/ServiceApply.aspx
*/
public class KdGoldAPIDemo {
//電商ID
private String EBusinessID="請(qǐng)到快遞鳥官網(wǎng)申請(qǐng)http://www.kdniao.com/ServiceApply.aspx";
//電商加密私鑰,快遞鳥提供,注意保管,不要泄漏
private String AppKey="請(qǐng)到快遞鳥官網(wǎng)申請(qǐng)http://www.kdniao.com/ServiceApply.aspx";
//請(qǐng)求url, 正式環(huán)境地址: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':'EMS'," +
"'PayType':1," +
"'ExpType':1," +
"'Cost':1.0," +
"'OtherCost':1.0," +
"'Sender':" +
"{" +
"'Company':'LV','Name':'Taylor','Mobile':'15018442396','ProvinceName':'上海','CityName':'上海','ExpAreaName':'青浦區(qū)','Address':'明珠路73號(hào)'}," +
"'Receiver':" +
"{" +
"'Company':'GCCUI','Name':'Yann','Mobile':'15018442396','ProvinceName':'北京','CityName':'北京','ExpAreaName':'朝陽區(qū)','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);
//根據(jù)公司業(yè)務(wù)處理返回的信息......
return result;
}
/**
* MD5加密
* @param str 內(nèi)容
* @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 內(nèi)容
* @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 內(nèi)容
* @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 發(fā)送POST方法的請(qǐng)求
* @param url 發(fā)送請(qǐng)求的 URL
* @param params 請(qǐng)求的參數(shù)集合
* @return 遠(yuǎn)程資源的響應(yīng)結(jié)果
*/
@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();
// 發(fā)送POST請(qǐng)求必須設(shè)置如下兩行
conn.setDoOutput(true);
conn.setDoInput(true);
// POST方法
conn.setRequestMethod("POST");
// 設(shè)置通用的請(qǐng)求屬性
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對(duì)象對(duì)應(yīng)的輸出流
out = new OutputStreamWriter(conn.getOutputStream(), "UTF-8");
// 發(fā)送請(qǐng)求參數(shù)
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的響應(yīng)
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塊來關(guān)閉輸出流、輸入流
finally{
try{
if(out!=null){
out.close();
}
if(in!=null){
in.close();
}
}
catch(IOException ex){
ex.printStackTrace();
}
}
return result.toString();
}
}
其他Api接口,請(qǐng)轉(zhuǎn)到快遞鳥具體查看相關(guān)文檔。
ps:Coolspan kdniao
總結(jié)
以上是生活随笔為你收集整理的各种电子面单-Api接口(顺丰、快递鸟、菜鸟)的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: shiro多账号登录(用户名,手机号,邮
- 下一篇: 新娘婚礼当天收到硕士录取通知书:真洞房花