1. 概述
1.1 應用場景
企業安全規範要求,不允許直連業務庫,程式碼開發API效率低,人工傳輸易出錯。
缺乏安全的資料共享機制,隨着資料消費端增加,IT 出現重複造輪子的傾向。
1.2 功能簡介
資料服務提供資料共享能力,可以將加工、融合後的數據封裝發佈為規範化 API API資料,供外部系統呼叫,實現資料價值匯出及共享開放。
2. 約束限制
當前僅支援Tomcat独立部署FDL版本使用。
FineDataLink 資料服務支援的資料源詳情參見:FineDataLink支援的資料源
注:推薦使用谷歌和 Edge 瀏覽器最新版本,其他瀏覽器可能會有相容問題。
3. 前提條件
使用 FineDataLink 的資料服務功能建立資料 API 需要註冊相關功能點,詳情參見:注册简介
非超級管理者使用者想要使用該功能需要為使用者分配 資料服務API管理權限
確認連結性:
發起 API 呼叫請求時,請求會下發至資料服務的伺服器,並被進一步轉發至資料源中執行資料查詢,因此需要保證可以存取相應的資料源及其所在的網路。需要在保證網路連通的前提下,再使用資料服務;如果網路不通,會導致 API 呼叫請求無法執行。您可設定 配置API黑白名单 進行控制。
4. 操作流程
4.1 發佈 API 流程
使用 FineDataLink 資料服務進行 API 發佈的操作流程如下:
注:資料服務完整範例請參見:数据服务简单示例
步驟 |
---|
步驟一:配置資料源 1)資料服務支援的資料源詳情參見:FineDataLink支援的資料源 2)在進行資料服務建立 API 之前,需要將已處理好、需要發佈資料對應的資料庫接入 FineDataLink,以便在 API 發佈配置程式中,可透過選擇資料源名稱來控制需要發佈的資料。詳情參見:建立並管理資料源 |
步驟二:發佈API 在 FDL 中發佈一個 API 需要三步,分別為:填寫 API 資訊、設定發佈內容及參數、預覽測試。詳情請參見:發佈API概述 知識擴展: 使用者可發佈包含參數的 API API,範例如下: |
步驟三:綁定 API 至應用 API 發佈後,需要將 API 綁定在「應用」中,以此獲取外部系統呼叫需要輸入鑑權認證,保證發佈的 API API在被外部系統呼叫時更安全。詳情請參見:綁定API至應用 「步驟二:發佈API」中也可以綁定應用 該步驟中,可以: 1)在應用中匯出 API 說明文檔,提供給呼叫者,供呼叫者查看 2)綁定應用時,支援設定認證方式,認證方式支援:無認證、AppCode、摘要簽章認證 具體範例參考:
3)外部系統呼叫時開通黑白名單,可保證發佈的 API API在被外部系統呼叫時更安全。詳情請參見:配置API黑白名单 |
其他說明: 對 API 進行任務管理、監視,查看運作狀態和 API 呼叫情況、批量上下線 API 等,請參見:資料服務維運 注1:4.1.6.3 及之後版本,API任務、資料服務應用禁止被多人同時編輯。詳情請參見:任务禁止被多人同时编辑 注2:4.1.9.3 及之後的版本支援使用「回收站」進刪除任務的還原、管理,詳情請參見:回收站 注3:4.2.0.3 及之後版本,支援指定排序欄位。詳情請參見:發佈API概述 |
4.2 呼叫已發佈的 API 流程
步驟 |
---|
步驟一:獲得 API 相關資訊 呼叫者需要獲取待呼叫 API 的完整路徑地址、參數、認證等資訊 有以下兩種方案:
|
步驟二:呼叫 API 可呼叫 API 具體說明請參見: |
5. 相容說明
1)4.0.24 及之前的版本升級 4.0.28 版本:
對於 API 發佈方,需要重建立立一遍已有 API,或是透過我們的客製腳本完成遷移。
對於呼叫方,在呼叫時由於增加了應用ID路徑,需要手動修改API的存取地址。
升級前若 API 設定了參數,會自動將參數值連接上單引號傳送,更新後,所見即所傳,不會自動連接單引號過去,可能會需要調整發布SQL或者傳參方式。
2)4.0.26 及之後的版本升級 4.0.28 版本:
對於呼叫方,在呼叫時由於增加了應用ID路徑,需要手動修改API的存取地址。
升級前若 API 設定了參數,會自動將參數值連接上單引號傳送,更新後,所見即所傳,不會自動連接單引號過去,可能會需要調整發布SQL或者傳參方式。
如有需要可聯絡帆軟技術支援,聯絡方式:前往「服務」,選擇「線上支援」、電話「400-811-8890」。
6. 注意事項
若使用者使用 FineDataLink 資料服務發佈的 API 由於跨域問題無法呼叫,可以修改 FineDataLink 伺服器目錄 %tomcat%.../conf/web.xml,刪除OPTIONS的配置,如下圖所示:
然後重啟工程。
注:此操作有一定的安全風險。
7. API匯出與資料服務的差別
差別項 | API匯出 | 資料服務 |
---|---|---|
功能說明 | 「API匯出」算子,可呼叫業務系統的API,修改業務系統的資料 可參考範例進行理解:活动日程信息更新至企业微信日程、新增/修改宜搭表单数据 | 將處理後的資料,封裝發佈為規範化的 API API,供外部系統呼叫 資料服務生成的是一個APIAPI,可供外部系統呼叫 可參考範例進行理解:数据服务简单示例 |