C#開發BIMFACE系列10 服務端API之獲取文件下載鏈接
- 2019 年 10 月 5 日
- 筆記
系列目錄 【已更新最新開發文章，點擊查看詳細】
通過BIMFACE控制台或者調用服務接口上傳文件成功後，默認場景下需要下載該源文件，下載文件一般需要知道文件的下載鏈接即可。BIMACE平台提供了「獲取文件下載鏈接」的服務接口。下面詳細介紹其使用方法。
請求地址：GET https://file.bimface.com/download/url
說明：應用通過該接口獲取文件的下載地址，然後下載文件。下載地址有效時間是5分鐘。
參數：
請求 path(示例)：https://file.bimface.com/download/url?fileId=1419273043501216
請求 header(示例)："Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP響應示例(200)：
{ "code" : "success", "data" : "data", // 請求成功後返回的文件下載鏈接 "message" : "" }
C#實現方法：
1 /// <summary> 2 /// 獲取文件下載鏈接 3 /// </summary> 4 /// <param name="accessToken">令牌</param> 5 /// <param name="fileId">文件ID</param> 6 /// <param name="name">文件名稱</param> 7 /// <returns></returns> 8 public virtual FileDownloadUrlGetResponse GetFileDownloadUrl(string accessToken, string fileId, string name = "") 9 { 10 //GET GET https://file.bimface.com/download/url 11 string url = string.Format(BimfaceConstants.FILE_HOST + "/download/url?fileId={0}", fileId); 12 if (name.IsNotNullAndWhiteSpace()) 13 { 14 url = url + "&name=" + name.UriEscapeDataString(); 15 } 16 BimFaceHttpHeaders headers = new BimFaceHttpHeaders(); 17 headers.AddOAuth2Header(accessToken); 18 19 try 20 { 21 FileDownloadUrlGetResponse response; 22 23 HttpManager httpManager = new HttpManager(headers); 24 HttpResult httpResult = httpManager.Get(url); 25 if (httpResult.Status == HttpResult.STATUS_SUCCESS) 26 { 27 response = httpResult.Text.DeserializeJsonToObject<FileDownloadUrlGetResponse>(); 28 } 29 else 30 { 31 response = new FileDownloadUrlGetResponse 32 { 33 Message = httpResult.RefText 34 }; 35 } 36 37 return response; 38 } 39 catch (Exception ex) 40 { 41 throw new Exception("[獲取文件下載鏈接]發生異常！", ex); 42 } 43 }
其中引用的 httpManager.Get() 方法，請參考《C#開發BIMFACE系列6 服務端API之獲取文件信息》，方法完全一樣。
測試
在BIMFACE的控制台中可以看到我們上傳的文件列表
選擇任意一個文件的ID來做測試
可以看到獲取文件下載鏈接成功，返回了以下信息：文件下載鏈。
複製下載鏈接到瀏覽器的地址欄中，回車即開始下載文件
下載地址有效時間是5分鐘，5分鐘後該鏈接即失效。 如果再下載，需要重新獲取下載鏈接。
測試程序如下：
// 獲取文件下載鏈接 protected void btnGetFileDownloadUrl_Click(object sender, EventArgs e) { txtFileInfo.Text = string.Empty; string token = txtAccessToken.Text; string fileId = txtFileId.Text; FileApi api = new FileApi(); FileDownloadUrlGetResponse response = api.GetFileDownloadUrl(token, fileId); txtFileInfo.Text = response.Code + Environment.NewLine + response.Message + Environment.NewLine + response.Data.ToString(); }
系列目錄 【已更新最新開發文章，點擊查看詳細】
