開放平台業務場景示例

1.1 功能簡介

目前，很多客戶已經基於開放平台，完成了系統整合，並應用到實際業務中，成功解決了業務問題和需求。

本文檔詳細介紹在實際業務中，如何應用開放平台，與客戶的資料中台深度整合，進而充分發揮資料中台的價值。

注：以下介紹內容的前端介面為客戶實際開發介面，本文檔只介紹API對接邏輯，不講解實際系統的開發邏輯，相關效果僅供理解參考。

1.2 預期效果

客戶資料中台推出了資料建模，希望透過開放平台，可直接更換 FineBI 資料準備中的原資料模型，只借助 FineBI 中的設計功能去開發報表。

2.1 環境準備

安裝FineBI，版本要求5.1.18及以上版本

安裝FineBIAPI子插件

2.2 開放平台配置

1）在平台管理中進入開放平台—應用管理，建立應用

2）點選編輯，獲取自動生成的應用ID和金鑰

3）在權限管理中，開放FineBIAPI的權限

注：在後續的API呼叫中，均需要在Header參數中新增以下參數

decUser：帳號（需要有BI編輯權限的使用者）

client_id：步驟（2）中獲取的應用ID

secret：步驟（2）中獲取的金鑰

2.3 資料中台對接

業務人員在資料中台頁面，選擇具體的維度和指標資訊，如下圖所示；

此時頁面會根據選擇的資訊在後台生成對應的sql；開發人員在開發時，需要將sql資訊和其他提前準備好的資訊，對接如下API：

2.3.1 BI建立SQL資料集API

API文檔地址：https://console-docs.apipost.cn/preview/8235cdbf59160235/261d4ec087ce3925?target_id=6cd43991-55ad-4895-990d-99eefa840ab1

APIURL：

APIURL中的engineName，請根據實際情況填寫：engineName：直連-direct；抽取-spider；如下圖

具體見：https://console-docs.apipost.cn/preview/8235cdbf59160235/261d4ec087ce3925?target_id=440b0363-08cf-4f09-aa81-8dd5a2a33ef7

Body請求參數：

將步驟（1）中獲取的SQL資訊，以及已知的資料夾、資料連結資訊，透過此API建立SQL資料集，具體見下圖；

實際操作中，開發人員在開發的同時，需要將建立資料集的相關資訊儲存一遍，用於後續系統進行相關資訊的查詢和呼叫

迴應：

記錄得到資料集名稱transfername，該參數將用於後續的儀錶板建立

2.3.2 BI儀錶板建立API

API文檔地址：https://console-docs.apipost.cn/preview/8235cdbf59160235/261d4ec087ce3925?target_id=e6215617-603e-4eb0-a17e-5338b598447f

參考1）BI建立SQL資料集API的步驟，該API較為複雜，只介紹部分重要參數的情況

Body請求參數：

根據上一步API的回傳資訊中的transferName及其他已知資訊，建立儀錶板，並建立預設組件。參數中的tablename為transfername

迴應：
系統在後台建立對應的儀錶板及一個預設組件

2.4 進入開發

完成以上的API對接後，將最後步驟API傳回的儀錶板ID，按照固定結構連結後，即可進入到BI開發頁面進行BI的自助分析。

目前開發平台整體對接流程清晰，權限設定也比較簡便，開發人員在開發頁面的時候，可以方便的進行API的管理和使用。

在對接效果層面，透過API省略中間步驟，可以讓實際業務應用人員擁有更好的交互體驗，透過深度整合，可以減弱甚至去除不同系統之間的割裂感。