通用快递单号自动识别接口文档

一、产品介绍

快递单号识别

输入运单号自动识别物流公司,实时返回对应物流公司编码。查询单号时,返回的结果可能存在一个或多个物流公司编码,快递鸟大数据平台通过智能分析,实时更新单号库,保障物流公司编码准确率。

通用快递单号自动识别接口文档

二、产品功能

实时查询:输入运单号自动识别物流公司编码,结合物流轨迹查询接口完成轨迹查询功能。(单号识别使用次数:3万次/天)

通用快递单号自动识别接口文档

三、接口说明

 PC端、移动端应用或网站应用集成运单物流信息查询功能时,只需要录入单号即可完成查询,无需用户输入快递公司。

电商网站要在快递鸟查询或者订阅运单时,可通过单号识别先行判断物流公司后,再订阅到快递鸟。

1.对接描述

1.该接口仅对运单号做出识别,识别可能属于的一家或多家快递公司。
2.接口并不返回物流轨迹,用户可结合即时查询接口和订阅查询接口完成轨迹查询、订阅的动作。
3.接口识别会返回一家或者多家快递公司,返回的数据根据快递鸟大数据分析结果排序,排名靠前的命中率更高。
4.若识别失败,快递鸟返回的匹配结果为空。
5.接口支持的消息接收方式为HTTP POST,请求方法的编码格式(utf-8):”application/x-www-form-urlencoded;charset=utf-8″。
6. 快递查询官网地址:http://www.kdniao.com/
7.接口API文档与Demo文档下载:http://www.kdniao.com/api-recognise

2.参数列表

2.1请求系统级参数说明

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

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

2.2接口地址

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

2.3请求内容字段定义

参数名称类型说明是否必须
LogisticCodeString物流单号R

2.4返回参数定义

参数名称类型说明必须要求
EBusinessIDString电商用户IDR
LogisticCodeString物流单号R
SuccessBool成功与否R
CodeInt失败原因O
ShipperShipperCodeString快递公司编码O
ShipperNameString快递公司名称O

四.对接案例

1.JSON请求

{

   “LogisticCode”: “3967950525457”

}

2.JSON返回

{

    “EBusinessID”: “1257021”,

    “Success”: true,

    “LogisticCode”: “3967950525457”,

    “Shippers”: [

            {

              “ShipperCode”: “YD”,

              “ShipperName”: “韵达快递”

            }

          ]

}

3.C#对接demo

using System;

using System.Collections.Generic;

using System.IO;

using System.Linq;

using System.Net;

using System.Text;

using System.Web;

namespace KdGoldAPI

{

    public class KdApiOrderDistinguish

    {

        //电商ID

        private string EBusinessID = “请到快递鸟官网申请http://www.kdniao.com/ServiceApply.aspx”;

        //电商加密私钥,快递鸟提供,注意保管,不要泄漏

        private string AppKey = “请到快递鸟官网申请http://www.kdniao.com/ServiceApply.aspx”;

        //请求url

        //测试环境

        private string ReqURL = “http://testapi.kdniao.cc:8081/Ebusiness/EbusinessOrderHandle.aspx”;

        //正式环境

        //private string ReqURL = “http://api.kdniao.cc/Ebusiness/EbusinessOrderHandle.aspx”;

        /// <summary>

        /// Json方式  单号识别

        /// </summary>

        /// <returns></returns>

        public string orderTracesSubByJson()

        {

            string requestData = “{‘LogisticCode’: ‘3967950525457’}”;

            Dictionary<string, string> param = new Dictionary<string, string>();

            param.Add(“RequestData”, HttpUtility.UrlEncode(requestData, Encoding.UTF8));

            param.Add(“EBusinessID”, EBusinessID);

            param.Add(“RequestType”, “2002”);

            string dataSign = encrypt(requestData, AppKey, “UTF-8”);

            param.Add(“DataSign”, HttpUtility.UrlEncode(dataSign, Encoding.UTF8));

            param.Add(“DataType”, “2”);

            string result = sendPost(ReqURL, param);

            //根据公司业务处理返回的信息……

            return result;

        }

        /// <summary>

        /// Post方式提交数据,返回网页的源代码

        /// </summary>

        /// <param name=”url”>发送请求的 URL</param>

        /// <param name=”param”>请求的参数集合</param>

        /// <returns>远程资源的响应结果</returns>

        private string sendPost(string url, Dictionary<string, string> param)

        {

            string result = “”;

            StringBuilder postData = new StringBuilder();

            if (param != null && param.Count > 0)

            {

                foreach (var p in param)

                {

                    if (postData.Length > 0)

                    {

                        postData.Append(“&”);

                    }

                    postData.Append(p.Key);

                    postData.Append(“=”);

                    postData.Append(p.Value);

                }

            }

            byte[] byteData = Encoding.GetEncoding(“UTF-8”).GetBytes(postData.ToString());

            try

            {

                HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);

                request.ContentType = “application/x-www-form-urlencoded”;

                request.Referer = url;

                request.Accept = “*/*”;

                request.Timeout = 30 * 1000;

                request.UserAgent = “Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 2.0.50727; .NET CLR 3.0.04506.648; .NET CLR 3.0.4506.2152; .NET CLR 3.5.30729)”;

                request.Method = “POST”;

                request.ContentLength = byteData.Length;

                Stream stream = request.GetRequestStream();

                stream.Write(byteData, 0, byteData.Length);

                stream.Flush();

                stream.Close();

                HttpWebResponse response = (HttpWebResponse)request.GetResponse();

                Stream backStream = response.GetResponseStream();

                StreamReader sr = new StreamReader(backStream, Encoding.GetEncoding(“UTF-8”));

                result = sr.ReadToEnd();

                sr.Close();

                backStream.Close();

                response.Close();

                request.Abort();

            }

            catch (Exception ex)

            {

                result = ex.Message;

            }

            return result;

        }

        ///<summary>

        ///电商Sign签名

        ///</summary>

        ///<param name=”content”>内容</param>

        ///<param name=”keyValue”>Appkey</param>

        ///<param name=”charset”>URL编码 </param>

        ///<returns>DataSign签名</returns>

        private string encrypt(String content, String keyValue, String charset)

        {

            if (keyValue != null)

            {

                return base64(MD5(content + keyValue, charset), charset);

            }

            return base64(MD5(content, charset), charset);

        }

        ///<summary>

        /// 字符串MD5加密

        ///</summary>

        ///<param name=”str”>要加密的字符串</param>

        ///<param name=”charset”>编码方式</param>

        ///<returns>密文</returns>

        private string MD5(string str, string charset)

        {

            byte[] buffer = System.Text.Encoding.GetEncoding(charset).GetBytes(str);

            try

            {

                System.Security.Cryptography.MD5CryptoServiceProvider check;

                check = new System.Security.Cryptography.MD5CryptoServiceProvider();

                byte[] somme = check.ComputeHash(buffer);

                string ret = “”;

                foreach (byte a in somme)

                {

                    if (a < 16)

                        ret += “0” + a.ToString(“X”);

                    else

                        ret += a.ToString(“X”);

                }

                return ret.ToLower();

            }

            catch

            {

                throw;

            }

        }

        /// <summary>

        /// base64编码

        /// </summary>

        /// <param name=”str”>内容</param>

        /// <param name=”charset”>编码方式</param>

        /// <returns></returns>

        private string base64(String str, String charset)

        {

            return Convert.ToBase64String(System.Text.Encoding.GetEncoding(charset).GetBytes(str));

        }

    }

}

附:单号查询接口

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.security.MessageDigest;

import java.util.HashMap;

import java.util.Map;

public class KdniaoTrackQueryAPI {

//DEMO

public static void main(String[] args) {

KdniaoTrackQueryAPI api = new KdniaoTrackQueryAPI();

try {

String result = api.getOrderTracesByJson(“ANE”, “210001633605”);

System.out.print(result);

} catch (Exception e) {

e.printStackTrace();

}

}

//电商ID

private String EBusinessID=”请到快递鸟官网申请http://www.kdniao.com/ServiceApply.aspx”;

//电商加密私钥,快递鸟提供,注意保管,不要泄漏

private String AppKey=”请到快递鸟官网申请http://www.kdniao.com/ServiceApply.aspx”;

//请求url

private String ReqURL=”http://api.kdniao.cc/Ebusiness/EbusinessOrderHandle.aspx”;

/**

     * Json方式 查询订单物流轨迹

 * @throws Exception

     */

public String getOrderTracesByJson(String expCode, String expNo) throws Exception{

String requestData= “{‘OrderCode’:”,’ShipperCode’:'” + expCode + “‘,’LogisticCode’:'” + expNo + “‘}”;

Map<String, String> params = new HashMap<String, String>();

params.put(“RequestData”, urlEncoder(requestData, “UTF-8”));

params.put(“EBusinessID”, EBusinessID);

params.put(“RequestType”, “1002”);

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;

}

/**

     * XML方式 查询订单物流轨迹

 * @throws Exception

     */

public String getOrderTracesByXml() throws Exception{

String requestData= “<?xml version=\”1.0\” encoding=\”utf-8\” ?>”+

“<Content>”+

“<OrderCode></OrderCode>”+

“<ShipperCode>SF</ShipperCode>”+

“<LogisticCode>589707398027</LogisticCode>”+

“</Content>”;

Map<String, String> params = new HashMap<String, String>();

params.put(“RequestData”, urlEncoder(requestData, “UTF-8”));

params.put(“EBusinessID”, EBusinessID);

params.put(“RequestType”, “1002”);

String dataSign=encrypt(requestData, AppKey, “UTF-8”);

params.put(“DataSign”, urlEncoder(dataSign, “UTF-8”));

params.put(“DataType”, “1”);

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 = base64Encode(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();

    }

    private static char[] base64EncodeChars = new char[] {

        ‘A’, ‘B’, ‘C’, ‘D’, ‘E’, ‘F’, ‘G’, ‘H’,

        ‘I’, ‘J’, ‘K’, ‘L’, ‘M’, ‘N’, ‘O’, ‘P’,

        ‘Q’, ‘R’, ‘S’, ‘T’, ‘U’, ‘V’, ‘W’, ‘X’,

        ‘Y’, ‘Z’, ‘a’, ‘b’, ‘c’, ‘d’, ‘e’, ‘f’,

        ‘g’, ‘h’, ‘i’, ‘j’, ‘k’, ‘l’, ‘m’, ‘n’,

        ‘o’, ‘p’, ‘q’, ‘r’, ‘s’, ‘t’, ‘u’, ‘v’,

        ‘w’, ‘x’, ‘y’, ‘z’, ‘0’, ‘1’, ‘2’, ‘3’,

        ‘4’, ‘5’, ‘6’, ‘7’, ‘8’, ‘9’, ‘+’, ‘/’ };

    public static String base64Encode(byte[] data) {

        StringBuffer sb = new StringBuffer();

        int len = data.length;

        int i = 0;

        int b1, b2, b3;

        while (i < len) {

            b1 = data[i++] & 0xff;

            if (i == len)

            {

                sb.append(base64EncodeChars[b1 >>> 2]);

                sb.append(base64EncodeChars[(b1 & 0x3) << 4]);

                sb.append(“==”);

                break;

            }

            b2 = data[i++] & 0xff;

            if (i == len)

            {

                sb.append(base64EncodeChars[b1 >>> 2]);

                sb.append(base64EncodeChars[((b1 & 0x03) << 4) | ((b2 & 0xf0) >>> 4)]);

                sb.append(base64EncodeChars[(b2 & 0x0f) << 2]);

                sb.append(“=”);

                break;

            }

            b3 = data[i++] & 0xff;

            sb.append(base64EncodeChars[b1 >>> 2]);

            sb.append(base64EncodeChars[((b1 & 0x03) << 4) | ((b2 & 0xf0) >>> 4)]);

            sb.append(base64EncodeChars[((b2 & 0x0f) << 2) | ((b3 & 0xc0) >>> 6)]);

            sb.append(base64EncodeChars[b3 & 0x3f]);

        }

        return sb.toString();

    }

}

发表评论

您的电子邮箱地址不会被公开。 必填项已用*标注