Asp.Net Core 調(diào)用第三方Open API查詢物流數(shù)據(jù)的示例

更新時(shí)間：2021年03月05日 17:03:22 作者：Hello 尋夢(mèng)者！

這篇文章主要介紹了Asp.Net Core 調(diào)用第三方Open API查詢物流數(shù)據(jù)的示例，幫助大家更好的理解和學(xué)習(xí)使用Asp.Net Core，感興趣的朋友可以了解下

　　在我們的業(yè)務(wù)中不可避免要與第三方的系統(tǒng)進(jìn)行交互，調(diào)用他們提供的API來(lái)獲取相應(yīng)的數(shù)據(jù)，那么對(duì)于這樣的情況該怎樣進(jìn)行處理呢？下面就結(jié)合自己對(duì)接跨越速運(yùn)接口來(lái)獲取一個(gè)發(fā)運(yùn)單完整的物流信息為例來(lái)說(shuō)明如何在Asp.Net Core中通過(guò)代碼實(shí)現(xiàn)。當(dāng)然在他們的官方網(wǎng)站上面會(huì)給出具體的API調(diào)用方式以及參數(shù)格式，作為調(diào)用方只需要根據(jù)相應(yīng)規(guī)則來(lái)進(jìn)行編碼即可，下面以我們查詢某一個(gè)具體的發(fā)運(yùn)單的物流信息為例來(lái)進(jìn)行說(shuō)明。

　　下面以一個(gè)查詢路由詳細(xì)信息為例來(lái)進(jìn)行說(shuō)明。當(dāng)前接口主要包括：1 概述。 2 系統(tǒng)參數(shù)。 3 業(yè)務(wù)參數(shù)。 4 業(yè)務(wù)參數(shù)。5 返回結(jié)果。6 響應(yīng)數(shù)據(jù)格式。7 調(diào)用示例（Java語(yǔ)言）。這里主要是來(lái)說(shuō)明如何使用C#語(yǔ)言來(lái)進(jìn)行調(diào)用，其它語(yǔ)言的思路其實(shí)也是一樣的。

　　一構(gòu)造HttpClient對(duì)象

　　這里建議使用IHttpClientFactory這個(gè)接口來(lái)創(chuàng)建httpClient而不是直接new一個(gè)對(duì)象，至于具體原因網(wǎng)上有很多原因，具體理由也是IHttpClientFactory創(chuàng)建的HttpClient對(duì)象能夠在使用完得到更好的釋放資源的效果。在Asp.Net Core中直接在構(gòu)造函數(shù)中注入IHttpClientFactory接口，然后采用CreateClient方法來(lái)創(chuàng)建對(duì)象?！　?/p>

 public LogisticsService(IHttpClientFactory httpClientFactory) {
   _httpClient = httpClientFactory.CreateClient(PartsConsts.DcsPartClientName);
  }

　　這個(gè)CreateClient方法中需要傳一個(gè)標(biāo)識(shí)你現(xiàn)在使用的HttpClient的名稱。

　　二獲取參數(shù)Token

　　按照他們的API規(guī)范中說(shuō)的，在Headers中需要進(jìn)行Token傳遞的，這個(gè)稱之為請(qǐng)求票據(jù)，沒(méi)有這個(gè)是無(wú)法進(jìn)行驗(yàn)證的，首先我們需要定義一個(gè)用于請(qǐng)求Token的數(shù)據(jù)結(jié)構(gòu)，同時(shí)還需要根據(jù)他們的規(guī)范來(lái)定義一個(gè)接收Token的數(shù)據(jù)結(jié)構(gòu)。

　　A 請(qǐng)求Token的數(shù)據(jù)結(jié)構(gòu)　　

public class LogisticsUser {
  public string appkey { get; set; }

  public string appsecret { get; set; }
 }

　　B 接收Token的數(shù)據(jù)結(jié)構(gòu)

public class CodeMsg {
  public int Code { get; set; }
  public string Msg { get; set; }
  public bool Success { get; set; }
 }

public class TokenResult : CodeMsg {
  public TokenData Data { get; set; }
 }

 public class TokenData {
  public string Refresh_token { get; set; }

  public int Expire_time { get; set; }

  public string Token { get; set; }
 }

　　C 同步請(qǐng)求方法

/// <summary>
  /// 同步請(qǐng)求post（鍵值對(duì)形式）
  /// </summary>
  /// <param name="url"></param>
  /// <param name="postdate"></param>
  /// <param name="formData"></param>
  /// <param name="charset"></param>
  /// <param name="mediaType"></param>
  /// <returns></returns>
  public async Task<string> HttpPostAsync(string url, string postdate = null, List<KeyValuePair<string, string>> formData = null,
   string charset = "UTF-8", string mediaType = "application/json") {

   HttpContent content = new StringContent(postdate);
   content.Headers.ContentType = new MediaTypeHeaderValue(mediaType) {
    CharSet = charset
   };
   foreach (var data in formData) {
    content.Headers.Add(data.Key, data.Value);
   }
   var response = await _httpClient.PostAsync(url, content);

   var result = await response.Content.ReadAsStringAsync();

   return result;
  }

　　這個(gè)方法是一個(gè)常規(guī)的異步請(qǐng)求方法，這里使用HttpContent作為數(shù)據(jù)載體，將一些重要的系統(tǒng)參數(shù)添加到Headers里面，將業(yè)務(wù)參數(shù)傳遞到StringContent的構(gòu)造函數(shù)中去，最后調(diào)用PostAsync異步方法發(fā)送Post請(qǐng)求，請(qǐng)求完了通過(guò)返回的Response來(lái)獲取返回的數(shù)據(jù)，通過(guò)這種方式來(lái)獲取完整的數(shù)據(jù)結(jié)構(gòu)。這里特別需要注意如果第一次請(qǐng)求Token失敗則可以再次請(qǐng)求重新刷新Token,最后將獲取的Json類型Token反序列化為我們定義的TokenResult結(jié)構(gòu)，這樣我們就能夠正常獲取到Token數(shù)據(jù)了。

　　三獲取發(fā)運(yùn)單數(shù)據(jù)

　　我們之前所有的工作都是為了能夠獲取到最終的業(yè)務(wù)數(shù)據(jù)，那么這里我們也是一樣，首先要定義請(qǐng)求和接收數(shù)據(jù)的數(shù)據(jù)結(jié)構(gòu)，首先是請(qǐng)求的數(shù)據(jù)結(jié)構(gòu)。

public class LogisticsInputModel {
  [JsonProperty("customerCode")]
  public string CustomerCode { get; set; }

  [JsonProperty("waybillNumbers")]
  public string[] WaybillNumbers { get; set; }
 }

　　這里面CustomerCode是我們用戶編碼，這個(gè)是唯一的，這是跨越速運(yùn)官方給予的用戶憑證，第二個(gè)WaybillNumbers 就是我們需要查詢的發(fā)運(yùn)單的集合，這里的接口支持一次性查詢多個(gè)發(fā)運(yùn)單數(shù)據(jù)，所以接口使用string[ ]數(shù)組類型。

　　下面來(lái)說(shuō)一下根據(jù)官方定義來(lái)定義查詢物流信息的接口定義。

/// <summary>
 /// 跨越速運(yùn)查詢物流信息接口
 /// </summary>
 public class LogisticInfoModel {
  public string Code { get; set; }

  public string Msg { get; set; }

  public bool? Success { get; set; }

  public DataInfo Data { get; set; }

  public string TraceId { get; set; }
 }

 public class DataInfo {
  public string ResultCount { get; set; }

  public IList<EsWayBillInfo> EsWayBill { get; set; }
 }

 public class EsWayBillInfo {
  public EsWayBillInfo() {
   ExteriorRouteList = new List<ExteriorRoute>();
  }

  public string WaybillNumber { get; set; }

  public string ProductCode { get; set; }

  public string ReceiveDate { get; set; }

  public string Receiver { get; set; }

  public string ExpectedDate { get; set; }

  public string MailingTime { get; set; }

  public string ServiceMode { get; set; }

  public string MailingAddress { get; set; }

  public string ReceivingAddress { get; set; }

  public string Addressee { get; set; }

  public string Sender { get; set; }

  public string TotalFreightAmount { get; set; }

  public string Count { get; set; }

  public string FreightWeight { get; set; }

  public decimal? Size { get; set; }

  public IList<ExteriorRoute> ExteriorRouteList { get; set; }
 }


 public class ExteriorRoute {
  public int Id { get; set; }

  public string RouteStep { get; set; }

  public string RouteDescription { get; set; }

  public string UploadDate { get; set; }
 }

　　有了輸入請(qǐng)求參數(shù)，當(dāng)然也需要能夠接受最終數(shù)據(jù)的數(shù)據(jù)接口，這些數(shù)據(jù)結(jié)構(gòu)首先都要定義好，而且必須和官方保持一致，否則就無(wú)法進(jìn)行反序列化操作。

　　有了這些準(zhǔn)備工作我們來(lái)看看最核心的獲取業(yè)務(wù)數(shù)據(jù)的過(guò)程，我們會(huì)在稍后來(lái)對(duì)其中的一些代碼進(jìn)行說(shuō)明。

public async Task<IList<EsWayBillInfo>> GetLogisticsInformationAsync(LogisticsInputModel input) {
   var parameter = new List<KeyValuePair<string, string>>();
   var nowDate = (DateTime.Now.ToUniversalTime() - new DateTime(1970, 1, 1)).TotalMilliseconds.ToString(CultureInfo.InvariantCulture);
   var jsonParam = JsonConvert.SerializeObject(input);
   var logisticsUser = new LogisticsUser() {
    appkey = Appkey,
    appsecret = Appsecret
   };
   parameter.Add(new KeyValuePair<string, string>("X-from", "openapi_ap"));

   var tokenResult = await HttpPostAsync(TokenUrl, JsonConvert.SerializeObject(logisticsUser), parameter);
   var codeMsg = JsonConvert.DeserializeObject<TokenResult>(tokenResult);

   //Token失效，調(diào)用刷新Token接口，返回新Token
   if (codeMsg.Data.Expire_time <= 0) {
    var tokenRefreshResult = await HttpPostAsync(RefreshTokenUrl,
     "{\"refresh_token\": \"" + codeMsg.Data.Refresh_token + "\"}", parameter);
    codeMsg = JsonConvert.DeserializeObject<TokenResult>(tokenRefreshResult);
   }

   parameter.Clear();
   parameter.Add(new KeyValuePair<string, string>("appkey", Appkey));
   parameter.Add(new KeyValuePair<string, string>("format", Format));
   parameter.Add(new KeyValuePair<string, string>("timestamp", nowDate));
   parameter.Add(new KeyValuePair<string, string>("method", QueryRoute));
   parameter.Add(new KeyValuePair<string, string>("sign", MD5Hash(Sign + nowDate + jsonParam).ToUpper()));
   parameter.Add(new KeyValuePair<string, string>("token", codeMsg.Data.Token));
   var result = await HttpPostAsync(RestUrl, jsonParam, parameter);
   return JsonConvert.DeserializeObject<LogisticInfoModel>(result)?.Data?.EsWayBill;
  }

　　這里有一些需要說(shuō)明的部分，首先獲取nowDate的時(shí)候是獲取UTC時(shí)間，其次獲取sign的時(shí)候需要對(duì)內(nèi)容進(jìn)行MD5加密的過(guò)程。Asp.Net Core中的MD5加密比較簡(jiǎn)單，采用下面的方式即可。

/// <summary>
  /// netcore下的實(shí)現(xiàn)MD5加密
  /// </summary>
  /// <param name="input">加密內(nèi)容</param>
  /// <returns></returns>
  private string MD5Hash(string input) {
   using (var md5 = MD5.Create()) {
    var result = md5.ComputeHash(Encoding.ASCII.GetBytes(input));
    var strResult = BitConverter.ToString(result);
    return strResult.Replace("-", "");
   }
  }

　　這里使用Using包裹便于進(jìn)行非托管對(duì)象的釋放，這里需要注意，還有一些常用的const變量定義為局部變量即可，有了這些就能夠創(chuàng)建一個(gè)完整的根據(jù)發(fā)運(yùn)單號(hào)來(lái)獲取完整的物流數(shù)據(jù)的第三方API對(duì)接過(guò)程了。

private const string Appkey = "80069";
  private const string Format = "json";
  private const string Appsecret = "XXXE034XXX355889DC68BB40BEDXXX0";
  private const string QueryRoute = "open.api.openCommon.queryRoute";
  private const string Sign = "XXXE034545E355889DC68BB40BEDXXX";
  private const string TokenUrl = "https://open.ky-express.com/security/token";
  private const string RefreshTokenUrl = "https://open.ky-express.com/security/token/refresh";
  private const string RestUrl = https://open.ky-express.com/router/rest;

　　最后我們來(lái)看看通過(guò)整個(gè)調(diào)用過(guò)程獲取物流信息并在系統(tǒng)中進(jìn)行展示的效果。