Asp.Net Core 調用第三方Open API查詢物流數據的示例
在我們的業務中不可避免要與第三方的系統進行交互，調用他們提供的API來獲取相應的數據，那麼對於這樣的情況該怎樣進行處理呢？下面就結合自己對接跨越速運接口來獲取一個發運單完整的物流信息為例來說明如何在Asp.Net Core中通過代碼實現。當然在他們的官方網站上面會給出具體的API調用方式以及參數格式，作為調用方隻需要根據相應規則來進行編碼即可，下面以我們查詢某一個具體的發運單的物流信息為例來進行說明。
下面以一個查詢路由詳細信息為例來進行說明。當前接口主要包括：1 概述。 2 系統參數。 3 業務參數。 4 業務參數。5 返回結果。6 響應數據格式。7 調用示例（Java語言）。這裡主要是來說明如何使用C#語言來進行調用，其它語言的思路其實也是一樣的。
一 構造HttpClient對象
這裡建議使用IHttpClientFactory這個接口來創建httpClient而不是直接new一個對象，至於具體原因網上有很多原因，具體理由也是IHttpClientFactory創建的HttpClient對象能夠在使用完得到更好的釋放資源的效果。在Asp.Net Core中直接在構造函數中註入IHttpClientFactory接口，然後采用CreateClient方法來創建對象。
public LogisticsService(IHttpClientFactory httpClientFactory) {
_httpClient = httpClientFactory.CreateClient(PartsConsts.DcsPartClientName);
}
這個CreateClient方法中需要傳一個標識你現在使用的HttpClient的名稱。
二 獲取參數Token
按照他們的API規范中說的，在Headers中需要進行Token傳遞的，這個稱之為請求票據，沒有這個是無法進行驗證的，首先我們需要定義一個用於請求Token的數據結構，同時還需要根據他們的規范來定義一個接收Token的數據結構。
A 請求Token的數據結構
public class LogisticsUser {
public string appkey { get; set; }
public string appsecret { get; set; }
}
B 接收Token的數據結構
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 同步請求方法
/// <summary>
/// 同步請求post（鍵值對形式）
/// </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;
}
這個方法是一個常規的異步請求方法，這裡使用HttpContent作為數據載體，將一些重要的系統參數添加到Headers裡面，將業務參數傳遞到StringContent的構造函數中去，最後調用PostAsync異步方法發送Post請求，請求完瞭通過返回的Response來獲取返回的數據，通過這種方式來獲取完整的數據結構。這裡特別需要註意如果第一次請求Token失敗則可以再次請求重新刷新Token,最後將獲取的Json類型Token反序列化為我們定義的TokenResult結構，這樣我們就能夠正常獲取到Token數據瞭。
三 獲取發運單數據
我們之前所有的工作都是為瞭能夠獲取到最終的業務數據，那麼這裡我們也是一樣，首先要定義請求和接收數據的數據結構，首先是請求的數據結構。
public class LogisticsInputModel {
[JsonProperty("customerCode")]
public string CustomerCode { get; set; }
[JsonProperty("waybillNumbers")]
public string[] WaybillNumbers { get; set; }
}
這裡面CustomerCode是我們用戶編碼，這個是唯一的，這是跨越速運官方給予的用戶憑證，第二個WaybillNumbers 就是我們需要查詢的發運單的集合，這裡的接口支持一次性查詢多個發運單數據，所以接口使用string[ ]數組類型。
下面來說一下根據官方定義來定義查詢物流信息的接口定義。
/// <summary>
/// 跨越速運查詢物流信息接口
/// </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; }
}
有瞭輸入請求參數，當然也需要能夠接受最終數據的數據接口，這些數據結構首先都要定義好，而且必須和官方保持一致，否則就無法進行反序列化操作。
有瞭這些準備工作我們來看看最核心的獲取業務數據的過程，我們會在稍後來對其中的一些代碼進行說明。
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失效，調用刷新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;
}
這裡有一些需要說明的部分，首先獲取nowDate的時候是獲取UTC時間，其次獲取sign的時候需要對內容進行MD5加密的過程。Asp.Net Core中的MD5加密比較簡單，采用下面的方式即可。
/// <summary>
/// netcore下的實現MD5加密
/// </summary>
/// <param name="input">加密內容</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包裹便於進行非托管對象的釋放，這裡需要註意，還有一些常用的const變量定義為局部變量即可，有瞭這些就能夠創建一個完整的根據發運單號來獲取完整的物流數據的第三方API對接過程瞭。
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;
最後我們來看看通過整個調用過程獲取物流信息並在系統中進行展示的效果。
以上就是Asp.Net Core 調用第三方Open API查詢物流數據的示例的詳細內容，更多關於Asp.Net Core 調用第三方API的資料請關註WalkonNet其它相關文章！