跳轉到

建立外部連線設定

一、外部連線設定的說明

當組織需要與外部系統進行整合、資料交換或同步時，需透過 外部連線設定 來建立UOF X系統與外部系統之間資料傳遞的橋樑。然而，可以和UOF X進行整合的來源包含 資料庫 或 API 等。以下是外部連線的優點：

  • 整合多個外部系統 ：UOF X系統可以與多個外部系統進行整合和資料傳遞，以提升系統使用的彈性。
  • 資料同步的一致性 ：能夠與外部系統進行數據的同步和交換。例如，可以將資料從UOF X系統傳送到外部系統，讓兩個系統的資料一致。
  • 更新與維護的靈活性 ：UOF X系統可以獨立更新，更新過程不會影響外部系統。
  • 增強安全性 ：可以在UOF X系統和外部系統間建立安全的管道，以保護敏感資料和防止未授權的服務，減少潛在的風險和影響範圍。

二、建立外部連線設定

BPM管理員在 外部連線設定 功能，可以選擇 API連線 或 SQL連線 兩種對外連線方式，透過連線設定，UOF X系統即可以建立與外部系統之間的連線，並且進行資料的交換和操作。

設定項目 說明
A. API主機位置
  • 查詢參數 (Query Parameters)：使用問號 ? 跟在URL後面，然後是鍵值對 key=value 的形式；例如：https://api.example.com/resource?id=123
  • 模板語法 (Template Syntax)：使用大括號 {}，這種方式常見於很多現代編程語言和框架中；例如：https://api.example.com/resource/{id}
B. API Key 確保UOF X 串接外部系統時，可使用這個API Key進行安全性驗證身分。
C. 使用權限 設定能使用此外部連線的人員，讓有權限的人員可以在後續的功能，例如： 表單驗證器 或 外部資料來源 可以使用此外部連線，如此一來可以確保系統和資料的安全性；若資訊處的人員擁有ERP系統連線權限，此人員可以使用這組連線資訊來設定表單送出前的相關驗證。
D. Http標頭 API可以設定Http標題(header)內容，包含身份驗證 (Authentication)、內容類型 (Content-Type)..，你可以根據個人需求自訂內容，輸入值支援輸入{函式值}格式。
E. 連線字串 設定MS SQL主機位置的連線資訊

若「外掛模組 Plugin程式」與「外部資料來源API程式」放在同一個資料夾下時，由於外掛模組有版本之分，因此若需要取得Plugin目前的執行版本時，你可以在指定目錄，接續{plugin:外掛模組代號Plugin code}，即可取得Plugin目前的執行版本。 https://api.example.com/resource{plugin:xxxx}/

💡路徑：管理者首頁>串接服務>外部連線設定

Image connection-list

三、UOF X API函式說明

  • UofxGetUnixTimeMilliseconds()：用於獲取當前時間的 Unix 時間戳記（毫秒）
  • UofxGetGuid()：用於生成唯一識別碼 (GUID)
  • UofxEncrypt([DataToEncrypt], [ApiKey], [Algorithm])：用於加密特定字串，並生成指定演算法的 HMAC 雜湊值，函式定義如下
Value 描述
[DataToEncrypt] 指定字串的組成格式為 {x-ClientId}{x-Timestamp}{x-Nonce}
  • {x-ClientId}：客戶端ID，是唯一標識客戶端的字串
  • {x-ClientId}：當前時間戳記，用於防止重複攻擊
  • {x-Nonce}：隨機碼，每次請求應該不同，以確保請求的唯一性和安全性
[ApiKey] API金鑰，用於加密過程中的密鑰，應妥善保管，不應暴露給未授權的使用者
[Algorithm] 指定使用的加密演算法，支援HMACSHA512

BPM管理員新增 API連線，可以使用Header方式傳遞與外部系統連線的驗證資訊，並且Header的Value可以使用UOF X函式來生成的所需要的字串，操作步驟如下：

  1. 點按[新增API連線]
  2. 輸入必要欄位資訊：連線代號、連線名稱、API主機位置、API Key、使用權限
  3. 維護「Http標頭」：建立以下Header屬性，且可以使用UOF X提供的函式，可參考以下範例的設定值
Key Value 描述
x-ClientId 自行命名 可識別的外部系統代號
x-Timestamp UofxGetUnixTimeMilliseconds() 時間戳記
x-Nonce UofxGetGuid() 隨機碼不允許重複
x-Signature UofxEncrypt("{x-ClientId}{x-Timestamp}{x-Nonce}", "HMACSHA512") 加密方式

Image connection-list

四、如何應用外部連線設定

完成外部連線設定後，即可將此資料套用在以下功能中，設定方式如下：

Image connection-use