反饋已提交
網絡繁忙
升級3.0.8版本，此版本新增祕鑰加密儲存，如果已經安裝舊插件的工程，finedb表【fr_open_app】的secret欄位預設是varchar 256，需要手動改下資料庫的欄位長度，改為1000。
客戶在其自身的業務系統中，基於開放平台，可以透過存取應用，呼叫API的方式，整合帆軟產品能力，以及自訂的資料服務功能；
開放衆多功能API，使客戶可以方便快捷地應用帆軟產品能力。
帆軟提供「開放平台」插件：
1）提供安全、靈活、規範、有效的web服務，方便開發人員快速構建應用，實現在自身的業務系統中，對帆軟系統、報表進行相應的管理、開展資料服務。
2）提供統一的平台配置，實現使用者端API的權限管理、安全認證管理。
3）提供日誌管理功能，實現對於API、應用的請求、存取狀態查看。
1）官方API
對於開放平台中內建API，帆軟提供相關 API 文檔，方便使用者進行理解和使用。
該 API 文檔，僅作為官方範例，提供給具備自主產品整合能力的使用者使用。
注：平台API文檔為開放平台文檔。
FineReport、FineBIAPI文檔為同系列其他API插件文檔，需下載安裝相應子插件後，方可正常使用。
點選下載插件：開放平台插件
設計器插件安裝方法參照：設計器插件管理
伺服器安裝插件方法參照：伺服器插件管理
注：在安裝&升級插件時，如果同時安裝了同系列插件，需要在安裝&升級開放平台插件後重啟伺服器！
同系列插件列表：開放平台、開放平台-FineBIAPI、開放平台-FineReport報表API、開放平台-平台登入認證API。
插件安裝成功後，管理者登入數據決策系統，點選「管理系統>開放平台」，即可進入功能介面，如下圖所示：
注：V3.0.0新版本插件對API進行了更新，點選右上角可以「顯示/隱藏舊版本API」。
3. 功能簡介
各模組功能簡介如下表：
API查看：API功能、呼叫方式等
API管理：支援API的增刪改查和複製使用
在「API管理」中，包含第三方系統與FineReport進行資料互動服務的所有配置。
1）分組管理
「API管理」介面左側為分組。平台已內建多個分組，使用者可根據需需求，自行增刪分組。
對於內建分組，使用者不可刪除和編輯。
對於非內建分組，使用者可進行編輯、刪除等操作。被刪除的分組內的API，會自動行動到預設分組中。
2）API管理
每個分組中可儲存多個API。平台已內建部分常用的API，使用者也可自行新增API。
對於內建API，使用者僅可進行編輯、複製、更換分組操作，不可刪除和禁用。
對於非內建API，使用者可進行編輯、複製、更換分組、刪除和禁用等操作。
注：V3.0.0新版插件為API增加了“白名單”屬性，支援為單個API設定IP白名單，以實現對API的存取控制。
1）新增應用
在「應用管理」中，使用者可以透過新增事件的方式，建立應用。
使用者點選「應用管理」，點選「增加」，設定相關內容，點選「確定」，即可新增應用。
自動生成的「應用ID」和「金鑰」，可用於API的鑑權，作為第三方系統的存取證件。
2）應用管理
對於新增的應用，支援新增、編輯、複製、禁用、單個刪除、批量刪除等操作。編輯時可重置金鑰。
認證方式為對外服務提供相關的安全保障，所有應用API均支援「自簽發token認證」的方式。
除此之外，平台內建了3種備選認證方式。使用者也可根據需求，自行增加新的認證方式。
「自簽發token認證」是所有的應用API天然支援的認證方式。不論是否選擇備選認證，該認證方式均可用。
該認證是方式是透過access_token來驗證登入資訊，access_token需先透過應用ID和金鑰獲取。獲取方式如下圖所示：
獲取token的請求連結為：$HOST/sp/client/api/token
API方法為：POST
將應用ID和金鑰寫入Query或Headers裏，應用ID和金鑰詳情可見3.2節應用管理。整體效果如下圖所示：
將獲取的access_token，寫入Headers的VALUE中，此時設定的KEY值為clientToken。根據對應API的配置，修改API方法與地址，即可呼叫相應的APIAPI。
整體效果如下圖所示：
開放平台內建了三種備選認證方式，僅允許使用者編輯、複製，不支援刪除和禁用，如下圖所示：
利用國密SM2橢圓算法進行加解密，對應用ID、金鑰以即時間戳進行簽章後，透過簽章和應用ID進行認證。
其中配置項priKey=金鑰、timeout=逾時時間（秒）
簽章_sign_=SM2(應用ID+金鑰+時間戳)+時間戳（毫秒）
在Headers中新增 _sign_={計算值}，clientId={應用ID}，即可直接存取應用
在不能使用token認證的情況下，可使用摘要演算法（比如 SM3/MD5/ SHA256），對應用ID、金鑰以即時間戳進行簽章後，透過簽章和應用ID進行認證。
其中配置項method=摘要算法、timeout=逾時時間（秒）
簽章_sign_= 摘要算法(應用ID+金鑰+時間戳)+時間戳（毫秒）
推薦使用這種認證方式，安全性更高
範例：
client_id=203bc7b8db1d423fb55824150327ef98
secret=98ffd41b86db4868a6875f57e6974bbc
timestamp=1600166180321
摘要算法為MD5
逾時時間為300秒
此時，簽章_sign_ =
MD5(clientId+secret+timestamp)+timestamp = EE6E14BCEC5724C3BC6FC08AFC5C2B111600166180321
使用應用ID和金鑰直接作為認證依據，直接呼叫服務。
無配置項，認證方式的編輯介面的配置資訊，不可自行編輯。
在Headers中新增 clientId={應用ID}、secret={金鑰} 即可直接存取應用
出於安全考慮，不推薦使用這種認證方式
使用者可新增認證方式，對於非內建認證方式，支援編輯、禁用、單個刪除、批量刪除等操作。
在「認證方式」頁面，點選「增加」按鈕，設定相關配置項，點選「確定」，即可新增認證方式。如下圖所示：
支援自訂「認證名稱」、「認證描述」和「API類」，方便使用者區分設定的認證方式
1）「認證名稱」必填，不可為空
2）「認證描述」選填
3）「API類」是需要實現的認證API的例項物件。同一個類，可以透過配置的改變，實現多種認證方式。
在認證方式的編輯介面的配置資訊中，需進行一些固定配置，例如摘要簽章認證需要定義「摘要算法」和「有效期」；
配置可以設定為加密項，這樣加密後的資訊在儲存後，也無法從前端讀取
注：在部分使用了nginx的環境中，clientId的底線會被識別為無效
當前的解決方案是傳遞 client_id和clientId 均可被識別，已完成迭代相容
針對非公開API，呼叫均需要做權限驗證。不同的場景、不同的應用，可呼叫的API範圍是不一樣的。管理者可以權限管理下，進行權限配置。
公開API可以隨意呼叫，不受權限驗證的約束。
注：目前不存在分組權限，意思是即使把某個分組權限開啟了，實質上也只是把當前分組下面的API的權限分配給了某個應用。
如果後續發生了API分組變更，或者該分組下API新增，那麼之前已設定好的API權限是不變的。
例如：針對一個應用，開啟目錄樹管理的分組權限，相當於開啟下屬所有API的權限。如果該分組下的API更換到其他分組，則該API仍保持權限開啟的狀態；如果在目錄樹管理的分組下，新增API，則該API為權限關閉狀態
在日誌管理中，管理者可以查看API的請求頻率和詳細記錄。
在全局設定介面，管理者完成配置後，點選「儲存」生效。如下圖所示：
文 檔回 饋
滑鼠選中內容，快速回饋問題
滑鼠選中存在疑惑的內容，即可快速回饋問題，我們將會跟進處理。
不再提示
10s後關閉