智能识别快递单号API 快递鸟接口

目录

    • 前言
    • 1.完成前期准备工作
    • 2.API接口
    • 3.请求参数(Headers)
    • 4.请求参数(Body)
    • 5.返回参数(Return)
    • 6.请求报文(示例)
    • 7.成功返回报文(示例)
    • 8.分步讲解(C#版本)
    • 9.项目实际场景应用效果
    • 10.关于签名

前言

单号识别API接口,主要也是为了提供用户使用体验,减少客户操作步骤,以及人工查错,客户提供快递单号,即可实时返回可能的一个或多个快递公司,存在多个快递公司结果的,大数据平台根据可能性、单号量,进行智能排序。我们在PC端、移动端应用或网站应用集成运单物流信息查询功能时,只需要录入单号即可完成查询,无需用户输入快递公司。这个接口解决了我2大问题。

1,提升用户体验,提高客户查单效率

传统的电商发货需要客服手动选择发货的物流公司,利于单号识别API接口,我们可以智能完成物流公司的选择

2,节省客服维护成本,提高单号查询精准度

我们经常会发现由于客户误选了快递公司,导致运单轨迹无法获取的原因,造成客户的投诉,通过单号识别的智能选择可以起到辅助作用

下面具体讲解实现过程.

1.完成前期准备工作

1.1,去快递鸟官网免费注册一个账号

1.2,免费获得一个apiKey(接口权限验证需要)

1.3,完成实名认证流程

1.4,订购一个免费套餐

2.API接口

2.1,测试调用地址:http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json

2.2,正式调用地址:http://api.kdniao.com/api/dist

2.3,请求方式:POST

2.4,编码格式(utf-8):application/x-www-form-urlencoded;charset=utf-8

2.5,返回类型:JSON

2.6,调试页面:http://kdniao.com/UserCenter/v2/SandBox/TrackQuery.aspx

2.7,调试工具:去调试(使用快递鸟账号登录)

3.请求参数(Headers)

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

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

4.请求参数(Body)

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

5.返回参数(Return)

参数名称 类型 说明 必须要求
EBusinessID String 电商用户ID R
LogisticCode String 物流单号 R
Success Bool 成功与否 R
Code Int 失败原因 O
Shipper ShipperCode String 快递公司编码
ShipperName String 快递公司名称 O

6.请求报文(示例)

{
“LogisticCode”: “3967950525457” }

7.成功返回报文(示例)

{ “EBusinessID”: “1257021”, “Success”: true, “LogisticCode”: “3967950525457”, “Shippers”: \[
{ “ShipperCode”: “YD”, “ShipperName”: “韵达快递” }
\]
}

8.分步讲解(C#版本)

8.1,请求数据包结构

在这里插入图片描述

8.2,C#调用代码示例

//电商ID  
string eEBusinessID = "test1617571";  
 //电商加密私钥,快递鸟提供,注意保管,不要泄漏  
string appKey= "554343b2-7252-439b-b4eb-1af42c8f2175";  
 //请求url  
string reqURL = "http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json";  
//请求指令   
string reqType="2002";  
//2-json   
string dataType = "2";   
//字符编码采用UTF-8   
string charset = "UTF-8";   
//JSON字符串string   
string jsonStr =   
"{\\\"LogisticCode\\\":\\\"JT0000052600488\\\"}" ;  
//把(jsonStr+APIKey)进行MD5加密  
string md5Str=MD5(jsonStr + apiKey, charset);  
//把md5Str 进行Base64编码  
string base64Str=base64(md5Str,charset);  
//进行URL编码 (utf-8)  
string datasign = HttpUtility.UrlEncode(base64Str, charset);   
//请求报文参数   
string postStr = "RequestType=reqType&EBusinessID= eEBusinessID&RequestData=jsonStr   
&DataSign= datasign&DataType=dataType";   
//通讯协议使用Http协议Post请求方式 返回轨迹数据  
string post = SendPost(reqURL, postStr);  
//获取到的post数据就是快递鸟返回的完整报文,接下来自己写一个解析json的方法就能获取到里面的字段信息。

8.3,C#调用方法

///  
    /// 字符串MD5加密  
    ///  
    ///要加密的字符串  
    ///编码方式  
    ///密文  
    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;  
        }  
    }  
    ///   
    /// base64编码  
    ///   
    /// 内容  
    /// 编码方式  
    ///   
    private string base64(String str, String charset)  
    {
       
        return Convert.ToBase64String(System.Text.Encoding.GetEncoding(charset).GetBytes(str));  
}  
 ///   
    /// Post方式提交数据,返回网页的源代码  
    ///   
    /// 发送请求的 URL  
    /// 请求报文参数  
    /// 远程资源的响应结果  
    private string SendPost(string url, string postData)  
    {
       
        string result = "";  
        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.ToString();  
        }  
        return result;  
    } 

9.项目实际场景应用效果

智能识别快递单号API 快递鸟接口_第1张图片

10.关于签名

快递鸟和第三方电子商务公司系统进行对接,有一定的安全机制。采用 IP 认证加签名
的方式对接,具体方案如下:

防止数据被篡改
在 POST 请求中会传递 5 个必须®参数
RequestData数据内容(URL 编码:UTF-8)
EBusinessID
用户 ID
RequestType=请求指令类型
DataSign== 数据内容签名:把(请求内容(未编码)+ApiKey)进行 MD5 加密,然后 Base64
编码,最后进行 URL(utf-8)编码
DataType==2(返回数据类型为 json)
注:
DataSign 生成后,对方接收到数据后,以同样的算法进行签名(推送接口 RequestType 为
101/102 不需要进行 URL 编码),生成摘要,对比两者的摘要是否相同,如果不同,说明传递过程中发生数据篡改。
调用接口的身份认证
注册成为快递鸟用户后,会生成对应的用户 ID 和 APIKey,用户 ID 相当于用户名,
APIKey 相当于密码。

你可能感兴趣的:(api,接口,c#)