1. 概述
1.1 版本
FineBI 版本 | JAR 包 |
---|---|
6.0.14 | 2023-10-08 |
1.2 功能場景
BI Rest API資料集支援FineBI對接WEB API進行取數
對接第三方的WEB API進行取數
透過JSON解析傳回的資料
注:暫時不支援 BI 6.1.X版本
2. 插件介紹
2.1 插件安裝
插件獲取:BI Rest API資料集插件
設計器插件安裝方法參照:設計器插件管理
伺服器安裝插件方法參照:伺服器插件管理
插件安裝/更新/禁用再啟動,需要重啟Fine BI後生效
2.2 插件使用
2.2.1 使用流程
1)安裝插件後,公共資料的建立資料集中出現「Rest資料集」選項
2)點選進入建立資料集介面,完成相關配置後,點選儲存
3)在資料預覽模組,可以預覽新增的資料集,該資料集可以用於BI分析中
2.2.2 面板配置說明
①:資料集名稱,可重新命名
②:請求類型,支援GET和POST請求方式
③:URL位址,填寫API完整地址即可
URL參數:Query參數會自動連接到URL地址中
API認證:支援的認證方式:無認證、Basic Auth、Bearer Token、其他認證(自訂Token)
請求頭:新增請求頭參數
請求體:只有在POST請求方式下,才需要配置Body
表單方式支援:form-data與x-www-form-urlencoded
正文方式支援:TEXT、JSON、XML
回傳值處理:回傳值處理支援JSON解析,透過使用JsonPath語句,尋找節點、獲取想要的資料
參數設定:支援配置參數,可以在API配置中引用參數(URL、Query參數值、認證參數、Header參數值、Body中均可使用)。
引用形式:${參數名}
2.2.3 全局配置
在「管理系統>系統管理>標準>RestAPI全局配置」中可以進行全局配置,設定日誌和連結池相關屬性。
3. 注意事項
1)當前預設都匯出為正文欄位。如需修改欄位類型,點選如圖所示的「編輯」按鈕,進行欄位類型轉換。
2)rest API資料集不支援增量更新的方式。