1. 概述
1.1 版本
| FineBI伺服器版本 | 功能變更 |
|---|---|
| 6.0 | - |
1.2 功能簡介
FineBI 透過各種樣式如表格、圖表等來呈現資料，進行統計分析。這些資料表格或圖表，使用者在開發系統的時候也可以自己編程來實現，但是工作量大，維護難。
因此使用者往往選用現成的軟體開發，最後將製作好的 FineBI 範本嵌入到自己的系統中，以節省項目開發週期。
使用者開發的系統基本上趨於 B/S 架構的瀏覽器/伺服器模式，因此需要將製作好的範本嵌入到系統的某一個頁面中，作為頁面的一部分。
本章節將詳細介紹 Web 頁面整合方法。
2. 索引
說明文檔僅提供官方API，提供給具備自主產品整合能力的使用者使用。技術支援不負責API範例的維護和使用問題解答。
簡單整合範例請參見：Web頁面簡單整合範例
API除錯注意事項請參見：Web頁面整合常見問題
2.1 資料API
注：直連結口，可在APIURL中，加一個direct即可。
例如新增分組：
抽取API：/v5/api/group/add
直連結口：/v5/api/direct/group/add
| 分類 | 用途 | 資料API |
|---|---|---|
| 資料更新 | 觸發全局更新 | /v5/api/conf/update/generate |
| 觸發單表/資料夾更新 | /v5/api/conf/update/pack/table | |
| 觸發批量更新 | /v5/api/conf/update/batch | |
| 獲取此次更新實體的資訊 | /v5/api/conf/update/instance/{taskInstanceId} | |
| 資料表 | 新增資料集-DB表/SQL表 | /v5/api/table/add |
| 編輯儲存資料集-DB表/SQL表 | /v5/api/table/update | |
| 修改資料集轉義名 | /v5/api/tables/{tableName}/rename | |
| 刪除資料集 | /v5/api/pack/delete | |
| 獲取資料集 | /v5/api/table/{tableName}/get | |
| 獲取我的分析下直連資料的查詢SQL | /v5/api/analysis/table/execute/sql/{tableName} | |
| 獲取資料集資料 | /v5/api/tables/fields/page | |
| 獲取資料集分頁資料 | /v5/api/tables/data/page | |
| 公共資料資料夾 | 新增資料夾 | /v5/api/pack/{groupId}/add |
| 重新命名資料夾 | /v5/api/pack/{packId}/rename | |
| 刪除資料夾 | /v5/api/pack/delete | |
| 獲取資料夾資訊 | /v5/api/conf/packs/{packId}/structure | |
| 獲取業務包中的表資訊 | /v5/api/conf/packs/{packId} | |
| 獲取公共資料根資料夾資訊 | /v5/api/conf/groups |
2.2 儀表板API
| 分類 | 用途 | API |
|---|---|---|
| 儀表板編輯 | 建立儀表板 | /v5/api/platform/dashboard/reports |
| 刪除儀表板 | /v5/api/platform/dashboard/report | |
| 重新命名儀表板 | /v5/api/platform/dashboard/rename | |
| 儀表板另存為 | /v5/api/platform/dashboard/saveas | |
| 建立公共連結 | /v5/api/platform/dashboard/{reportId}/create | |
| 儀表板查看 | 儀表板匯出Excel | /v5/api/dashboard/report/export/excel |
| 儀表板匯出PDF | /v5/api/dashboard/report/export/pdf | |
| 儀表板匯出圖片 | /v5/api/dashboard/report/export/png | |
| 儀表板分享 | 分享儀表板給其他使用者 | /v5/api/dashboard/share/user/result |
| 取消分享 | /v5/api/dashboard/share/user/rejection/result | |
| 分享給我的所有儀表板 | /v5/api/dashboard/share | |
| 儀表板分享給哪些使用者 | /v5/api/dashboard/share/user | |
| 儀表板資訊 | 獲取使用者資訊和使用者建立的儀表板 | /v5/api/dashboard/user/info |
| 獲取發佈管理節點下的儀表板資訊 | /v5/api/dashboard/search | |
| 獲取某個主題下的儀表板列表 | /v5/api/platform/dashboard/list | |
| 獲取儀表板資訊 | /v5/api/platform/dashboard/reports/info | |
| 獲取儀表板中所有組件的資訊 | /v5/api/dashboard/report/consanguinity |
2.3 整合API
| 分類 | 用途 | API |
|---|---|---|
| 頁面整合API | 儀表板編輯頁面 | /v5/design/report/{reportId}/edit |
| 儀表板預覽頁面 | /v5/design/report/{reportId}/view | |
| 公共資料頁面 | /v5/api/conf/page | |
| 公共資料表預覽頁面 | /v5/api/conf/page#config/{tableName} | |
| 我的分析頁面 | /v5/api/page/analysis | |
| 我的分析資料編輯頁面 | /v5/conf/analysis/page |
