C#调用快递100风格API接口查询物流的示例代码

接口对接准备

在使用C#接入快递物流查询功能前，需在相关的开放平台（如快递100等服务商网站）注册账号并获取必要的鉴权参数，主要包括：UID（应用ID）、Key（接口密钥）。此外，需确保项目已引用 System.Net 和 System.Runtime.Serialization.Json 命名空间，以便处理网络请求和数据序列化。

实体类定义

根据API返回的数据结构，定义对应的C#模型类以接收响应数据。以下是标准的响应实体类定义：

[DataContract]
public class SyncResponseEntity
{
    public SyncResponseEntity() { }

    /// <summary>
    /// 需要查询的快递代号
    /// </summary>
    [DataMember(Order = 0, Name = "id")]
    public string ID { get; set; }

    /// <summary>
    /// 需要查询的快递名称
    /// </summary>
    [DataMember(Order = 1, Name = "name")]
    public string Name { get; set; }

    /// <summary>
    /// 需要查询的快递单号
    /// </summary>
    [DataMember(Order = 2, Name = "order")]
    public string Order { get; set; }

    /// <summary>
    /// 消息内容
    /// </summary>
    [DataMember(Order = 5, Name = "message")]
    public string Message { get; set; }

    /// <summary>
    /// 服务器状态码
    /// </summary>
    [DataMember(Order = 6, Name = "errcode")]
    public string ErrCode { get; set; }

    /// <summary>
    /// 运单状态
    /// </summary>
    [DataMember(Order = 7, Name = "status")]
    public int Status { get; set; }

    /// <summary>
    /// 跟踪记录列表
    /// </summary>
    [DataMember(Order = 8, Name = "data")]
    public List<Order> Data { get; set; }
}

[DataContract(Name = "data")]
public class Order
{
    public Order() { }
    public Order(string time, string content)
    {
        this.Time = time;
        this.Content = content;
    }

    [DataMember(Order = 0, Name = "time")]
    public string Time { get; set; }

    [DataMember(Order = 1, Name = "content")]
    public string Content { get; set; }
}

配置参数读取

将API所需的凭证信息存储在配置文件（如 Web.config）中，并通过工具类便捷读取。这避免了硬编码敏感信息，便于环境切换。

// 假设 Utils.GetAppConfig 是自定义的配置读取方法
public static int uid = Utils.GetAppConfig<int>("KUAIDIAPI_UID", 0);
public static string sync_url = Utils.GetAppConfig<string>("KUAIDIAPI_SYNC_URL", string.Empty);
public static string key = Utils.GetAppConfig<string>("KUAIDIAPI_KEY", string.Empty);

第1步：生成接口签名

大多数快递API要求对请求参数进行MD5加密签名以确保安全性。签名串通常包含 uid, key, customer (或 id), com (或 order), phone, resultv2 等字段。具体字段取决于所选服务商的要求，常见做法是将参数拼接后转为小写并进行MD5运算。

public static string GetSign(int uid, string key, string id, string order, string time)
{
    // 注意：不同API服务商的签名规则可能不同，此处为常见示例
    string sign = string.Format("uid={0}&key={1}&id={2}&order={3}&time={4}",
                uid,
                key,
                id,
                HttpUtility.UrlEncode(order.ToLower()),
                HttpUtility.UrlEncode(time));

    return Md5Encrypt(sign.ToLower(), "utf-8");
}

第2步：发起HTTP GET请求

构建完整的API请求URL，拼接入参和签名，并使用 HttpWebRequest 发送GET请求。此步骤需注意URL编码和时间戳参数的处理。

public static T APIQueryDataSYNC<T>(string id,
                   string order,
                   bool isSign,
                   bool isLast,
                   T defaultValue)
{
    try
    {
        string currTime = DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss");
        string currKey = key;
        
        // 如果需要签名验证
        if (isSign)
        {
            currKey = GetSign(uid, key, id, order, currTime);
            currKey += "&issign=true";
        }

        // 构建请求URL
        string url = sync_url + string.Format("?uid={0}&key={1}&id={2}&order={3}&time={4}",
                      uid, currKey, id, order, HttpUtility.UrlEncode(currTime));

        // 执行GET请求并获取HTML响应
        string html = GET_WebRequestHTML("utf-8", url);

        // 反序列化JSON响应
        if (!string.IsNullOrEmpty(html))
            return JsonToObj<T>(html, defaultValue);
    }
    catch (Exception ex)
    {
        throw new Exception(ex.Message);
    }

    return defaultValue;
}

辅助工具类实现

为了支持上述逻辑，需要实现包括MD5加密、JSON序列/反序列化以及HTTP GET/POST请求的基础工具类。这些方法封装了底层操作，提高代码复用性。

public class Utils
{
    // MD5加密辅助
    public static string Md5Encrypt(string strToBeEncrypt, string encodingName)
    {
        using (MD5 md5 = new MD5CryptoServiceProvider())
        {
            Byte[] FromData = System.Text.Encoding.GetEncoding(encodingName).GetBytes(strToBeEncrypt);
            Byte[] TargetData = md5.ComputeHash(FromData);
            string Byte2String = "";
            for (int i = 0; i < TargetData.Length; i++)
            {
                Byte2String += TargetData[i].ToString("x2");
            }
            return Byte2String;
        }
    }

    // JSON字符串转对象
    public static T JsonToObj<T>(string json, T defaultValue)
    {
        try
        {
            var serializer = new System.Runtime.Serialization.Json.DataContractJsonSerializer(typeof(T));
            using (var ms = new MemoryStream(Encoding.UTF8.GetBytes(json)))
            {
                object obj = serializer.ReadObject(ms);
                return (T)Convert.ChangeType(obj, typeof(T));
            }
        }
        catch
        {
            return defaultValue;
        }
    }

    // HTTP GET 请求封装
    public static string GET_WebRequestHTML(string encodingName, string url)
    {
        string result = string.Empty;
        try
        {
            Encoding encoding = Encoding.GetEncoding(encodingName);
            WebRequest webRequest = WebRequest.Create(url);
            HttpWebResponse httpWebResponse = (HttpWebResponse)webRequest.GetResponse();
            Stream responseStream = httpWebResponse.GetResponseStream();
            StreamReader streamReader = new StreamReader(responseStream, encoding);
            result = streamReader.ReadToEnd();
            httpWebResponse.Close();
            responseStream.Close();
            streamReader.Close();
        }
        catch (WebException ex)
        {
            throw new Exception(ex.Message);
        }
        return result;
    }

    // 其他辅助方法如 POST_HttpWebRequestHTML, XmlToObj 等可根据实际需求参照类似模式实现
}

在实际开发中，建议结合异常处理机制完善请求重试逻辑，并关注API服务商文档更新，确保签名规则和参数格式与服务端保持同步。以上就是C#调用快递API接口查询物流的详细内容，更多关于C#网络编程与API集成的资料请关注本站其它相关文章！