【教學】FsBP 資料庫 API 操作

回覆文章
EJ
新兵
新兵
文章: 9
註冊時間: 2024-10-01, 23:54

【教學】FsBP 資料庫 API 操作

文章 EJ »

一、基本說明

本部分說明如何使用 Postman 調用 FsBP 資料庫 API。為方便操作與測試,本範例提供一組 Postman Collection,使用者可匯入 JSON 檔案,並搭配 FsBP 提供的 Swagger API 文件,即可直接進行測試與操作。

二、事前準備


1.安裝 Postman

 [1] 下載網址:https://www.postman.com/downloads/

 [2] 安裝並啟動應用程式。


2. 下載FsBP憑證

 [1] 打開BOX Settings Tool畫面。

 [2] 左側選單點選【Security】。

 [3] 點選【Download the CA Certificate】。

20250417001.png
20250417001.png (51.9 KiB) 已瀏覽 1591 次

三、操作流程

1. 匯入 SSL 憑證至 Postman

 [1] 開啟 Postman。

 [2] 點選右上角的齒輪圖示。

 [3] 點選【Settings】。

 [4] 切換至 Certificates 分頁。

 [5] 點選【Add Certificate】。

 [6] 填寫Host。

 [7] 至CRT file選擇憑證檔案後點選【開啟】。

 [8] 點選【Add】。

20250416002.png
20250416002.png (39.31 KiB) 已瀏覽 1791 次

2. 匯入 FsBP Web API Collection

 [1] 開啟 Postman。

 [2] 點選左上角【Import】 。

 [3] 將提供的 .json 檔案拖曳至視窗。

匯入後FsBP Web API Collection 將顯示於左側「Collections」清單中,展開即可查看各項 API 測試範例。

20250416001.png
20250416001.png (27.05 KiB) 已瀏覽 1791 次
20250416004.png
20250416004.png (6.93 KiB) 已瀏覽 1791 次

3. 取得 Session ID

 [1] 在匯入的 Collection 中,找到「Auth 驗證」資料夾。

 [2] 點選 【external-auth API】。

 [3] 切換至「Body」分頁,填入帳號及密碼。

 [4] 點選【Send】執行

登入成功後,系統會回傳一組 Session ID。這組 Session ID 必須加在接下來要呼叫的 API 裡,放在標頭(Header)欄位,欄位名稱為 X-Field-Session-Id。

20250416008.png
20250416008.png (42.53 KiB) 已瀏覽 1791 次

4. 呼叫資料庫API

展開 Collection 中的 API 範例,於 Headers 欄位填入 Session ID,即可完成 API 調用。

20250416003.png
20250416003.png (129.5 KiB) 已瀏覽 1791 次
附加檔案
FsBP Web API.postman_collection.zip
(2.67 KiB) 已下載 11 次
回覆文章