電商企業在線預約快遞取件接口API對接demo

(1)支持自定義預約時間,不遺漏訂單
(2)已支持三通一達(申通不支持)、順豐、EMS、宅急送、德邦、優速等物流公司
(3)快遞公司會在兩小時內聯繫發件人並上門攬件
(4)接口支持的消息接收方式爲HTTP POST,請求方法的編碼格式(utf-8):“application/x-www-form-urlencoded;charset=utf-8”。
(5)PC端,移動端均能對接使用
(6)接口使用:在快遞鳥網站申請接口KEY

一、示例
請求示例 JSON

{
"OrderCode": "012657018199",
"ShipperCode": "SF",
"PayType": 1,
"MonthCode": "7553045845",
"ExpType": 1,
"Cost": 1.0,
"OtherCost": 1.0,
"Sender": {
  "Company": "LV",
  "Name": "Taylor",
  "Mobile": "15018442396",
  "ProvinceName": "上海",
  "CityName": "上海",
  "ExpAreaName": "青浦區",
  "Address": "明珠路"
},
"Receiver": {
  "Company": "GCCUI",
  "Name": "Yann",
  "Mobile": "15018442396",
  "ProvinceName": "北京",
  "CityName": "北京",
  "ExpAreaName": "朝陽區",
  "Address": "三里屯街道"
},
"Commodity": [
  {
    "GoodsName": "鞋子",
    "Goodsquantity": 1,
    "GoodsWeight": 1.0
  }
],
"AddService": [
  {
    "Name": "COD",
    "Value": "1020"
  }
],
"Weight": 1.0,
"Quantity": 1,
"Volume": 0.0,
"Remark": "小心輕放"
}

返回示例 JSON
失敗:

{
    "EBusinessID": "1237100",
    "Success": false,
    "ResultCode": "105",
    "Reason": "該訂單已經存在,請勿重複操作",
    "UniquerRequestNumber":"451d3c7c-b428-490a-a4ed-e368f15f6c74"
}

成功:

{
    "EBusinessID": "1237100",
    "Success": true,
    "Order": {
        "OrderCode": "012657018199",
        " ShipperCode ": " SF ",
        " LogisticCode ": ""
    },
    "ResultCode": "100",
    "Reason": ""
}

三、demo
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="請申請";    
    //電商加密私鑰,注意保管,不要泄漏
    private String AppKey="請申請";    
    //測試請求url
    private string ReqURL = "http://testapi.kdniao.cc:8081/api/oorderservice";
    //正式請求url
    //private string ReqURL = "http://api.kdniao.cc/api/OOrderService";

    /**
     * Json方式 在線下單
     * @throws Exception 
     */
    public String orderOnlineByJson() throws Exception{
        String requestData= "{'OrderCode': '012657700312'," +
                                  "'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}]," +
                                  "'AddService':" +
                                  "[{" +
                                  "'Name':'COD','Value':'1020'}]," +
                                  "'Weight':1.0," +
                                  "'Quantity':1," +
                                  "'Volume':0.0," +
                                  "'Remark':'小心輕放'," +
                                  "'Commodity':" +
                                  "[{" +
                                  "'GoodsName':'鞋子'," +
                                  "'Goodsquantity':1," +
                                  "'GoodsWeight':1.0}]" +
                                  "}";
        
        Map<String, String> params = new HashMap<String, String>();
        params.put("RequestData", urlEncoder(requestData, "UTF-8"));
        params.put("EBusinessID", EBusinessID);
        params.put("RequestType", "1001");
        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();
    }
}
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章