各種電子面單-Api介面(順豐、快遞鳥、菜鳥)
阿新 • • 發佈:2019-01-06
術語
對於一般人,電子面單的意思可能並不是很瞭解;說白了,就是快遞員給你列印的快遞單的電子版。
專業解釋:
電子面單是一種通過熱敏紙列印輸出紙質物流面單的物流服務。通過熱感應顯示文字,列印速度比傳統針式列印速度提升4~6倍。電子面單以介面形式嵌入到自己的系統、網站上,可以在自己的平臺操作列印電子面單。
電子面單樣式
對接介面各家對比
- 快遞電子面單介面:快遞公司自己開發的電子面單服務, 商家使用必須快遞公司上門做系統對接,使用一家快遞則需要對接一次。
- :可一次對接15家快遞公司, 無需和每一家快遞公司做對接。支援快遞有四通一達、EMS、宅急送、德邦、優速、天天、快捷、全峰等15家常用快遞公司,其中不包括順豐
- :可一次對接15家快遞公司, 無需和每一家快遞公司做對接。支援快遞有四通一達、順豐、EMS、宅急送、德邦、優速等15家快遞公司,對順豐有電子面單服務需求的可以選擇順豐自有的電子面單或者是快遞鳥電子面單。
各家合作流程對比
-
快遞電子面單介面
a. 和多家快遞公司申請賬號
b.分別進行介面對接
c.電子面單服務使用者向快遞網點申請開通及確認合作細節 -
菜鳥電子面單
a.向菜鳥網路提交對接申請
b.和菜鳥進行介面對接
c.電子面單服務使用者向菜鳥申請賬號
d.電子面單服務使用者向快遞網點申請開通及確認合作細節 -
快遞鳥電子面單
a. 進入申請賬號,獲取專屬的ID和KEY
b.和快遞鳥進行介面對接
c.電子面單服務使用者向快遞網點申請開通及確認合作細節;當然,順豐電子面單稍微特殊一點,即:順豐接入快遞鳥立馬可以使用,無需註冊賬號。
介面定義及說明
由於,當前快遞鳥支援的電子面單介面相對於其他家的有一定優勢;所以以下主要以快遞鳥為例進行展開闡述一一說明。
Request Params
系統級引數(公共引數)
引數名稱 | 型別 | 說明 | 是否必需 |
---|---|---|---|
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)。
介面引數
引數名稱 | 型別 | 說明 | 是否必需 |
---|---|---|---|
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 |
Cost | Double | 寄件費(運費) | O |
OtherCost | Double | 其他費用 | O |
StartDate | String | 上門取貨時間段:”yyyy-MM-dd HH:mm:ss”格式化,本文中所有時間格式相同 | O |
EndDate | String | 上門取貨時間段:”yyyy-MM-dd HH:mm:ss”格式化,本文中所有時間格式相同 | O |
Weight | Double | 物品總重量kg | O |
Quantity | Int | 件數/包裹數 | O |
Volume | Double | 物品總體積m3 | O |
Remark | String | 備註 | O |
IsReturnPrintTemplate | String | 返回電子面單模板:0-不需要;1-需要 | O |
Receiver | Company | String | 收件人公司 | O |
---|---|---|---|---|
Name | String | 收件人 | R | |
Tel | String | 電話與手機,必填一個 | R | |
Mobile | String | 電話與手機,必填一個 | R | |
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 | 電話與手機,必填一個 | R | |
PostCode | String | 發件人郵編 | O | |
ProvinceName | String | 發件省(如廣東省,不要缺少“省”) | R | |
CityName | String | 發件市(如深圳市,不要缺少“市”) | R | |
ExpAreaName | String | 發件區(如福田區,不要缺少“區”或“縣”) | O | |
Address | String | 發件人詳細地址 | R |
AddServices | ||||
---|---|---|---|---|
AddService | Name | String | 增值服務名稱 | O |
Value | String | 增值服務值 | O | |
CustomerID | String | 客戶標識(選填) | O |
Commoditys | ||||
---|---|---|---|---|
Commodity | GoodsName | String | 商品名稱 | R |
GoodsCode | String | 商品編碼 | O | |
Goodsquantity | String | 商品數量 | O | |
GoodsPrice | String | 商品價格 | O | |
GoodsWeight | String | 商品重量kg | O | |
GoodsDesc | String | 商品描述 | O | |
GoodsVol | String | 商品體積m3 | O |
Response Params
引數名稱 | 型別 | 說明 | 是否必需 |
---|---|---|---|
EBusinessID | String | 使用者ID | R |
Success | Bool | 成功與否 | R |
ResultCode | String | 錯誤編碼 | R |
Reason | String | 失敗原因 | O |
UniquerRequestNumber | String | 唯一標識 | R |
PrintTemplate | String | 面單列印模板 | O |
EstimatedDeliveryTime | String | 訂單預計到貨時間yyyy-mm-dd | O |
Callback | String | 使用者自定義回撥資訊 | O |
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 |
Java栗子
注:此栗子僅供參考,如要使用請到官方下載對應語言的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;
/**
*
* 快遞鳥電子面單介面
*
* @技術QQ: 4009633321
* @技術QQ群: 200121393
* @see: http://www.kdniao.com/MiandanAPI.aspx
* @copyright: 深圳市快金資料技術服務有限公司
*
* ID和Key請到官網申請:http://www.kdniao.com/ServiceApply.aspx
*/
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':'EMS'," +
"'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();
}
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204其他Api介面,請轉到快遞鳥具體檢視相關文件。