API 系統整合

1. Liferay API 整合能力

Liferay EIP 提供 Headless REST API,讓外部應用系統能夠透過標準介面存取平台資料,不必依賴 EIP 前端操作畫面,即可進行資料查詢、交換及更新。

透過 API 整合機制,企業可將 EIP 與既有 ERP、HR、BPM 或其他業務系統串接,依實際需求整合使用者、網站內容、文件及業務資料,建立跨系統的資訊交換機制。

 

2. API 技術規格

Liferay 7.4 採用標準化 API 架構,支援 REST、JSON 與 OpenAPI 規格,方便不同技術平台進行系統介接。

項目 支援能力
API 架構 Headless REST API
API 規格 OpenAPI 3.x
資料交換格式 JSON
通訊協定 HTTP / HTTPS
API 操作 資料查詢、新增、修改與刪除(依 API 支援範圍)
身分驗證 OAuth 2.0、Basic Authentication(依環境設定)
API 文件 OpenAPI 規格文件、API Explorer
API 擴充 REST Builder、自訂 REST API、Object API

 

3. 主要 API 整合範圍

Liferay EIP 提供多種類型的 API,涵蓋使用者管理、網站內容、文件及自訂業務資料,可依系統需求選用適合的介接服務。

API 類別 整合內容
使用者與組織 使用者帳號、組織、使用者群組、角色
網站內容管理 網站文章(Web Content)、分類、標籤
文件管理 文件、資料夾、檔案上傳與下載
站台與頁面 站台資訊、頁面及相關資料
自訂資料物件 Liferay Objects 業務資料查詢與維護
其他應用服務 透過既有 API 或客製服務擴充整合範圍

實際可使用的 API 及資料操作權限,依平台版本、已安裝模組與系統權限設定而定。

 

4. OpenAPI 文件與 API Explorer

Liferay 內建 API Explorer,提供視覺化的 API 文件查詢介面。開發人員可透過瀏覽器查看可用的 API、請求參數及回應資料格式,並在具備適當權限的情況下進行介接測試。

透過 OpenAPI 標準規格,也方便與 Postman、Swagger 等開發工具搭配使用,降低跨系統整合時的溝通與開發成本。

Liferay API Explorer - Headless REST API 文件與介接測試介面

 

5. API 安全與存取控管

企業系統透過 API 交換資料時,除了資料傳輸,也需要考量身分驗證、使用權限及資訊安全管理。Liferay API 可配合平台既有權限機制與安全設定,控管外部系統的資料存取。

  • 身分驗證:支援 OAuth 2.0 等驗證方式,確認 API 呼叫者身分。
  • 安全傳輸:透過 HTTPS 加密通訊,保護資料傳輸過程。
  • 權限控管:配合使用者、角色及資源權限,限制資料操作範圍。
  • 安全整合:可依企業資安需求搭配 API Gateway、存取紀錄及其他防護機制。

 

6. API 擴充與客製開發

除了平台既有的 API,Liferay 也提供 API 擴充機制,可依企業特殊業務需求開發專屬服務,支援不同系統之間的資料整合。

例如,將 ERP 或 HR 系統資料整合至 EIP 工作台、提供外部系統查詢特定業務資訊,或透過自訂 API 交換企業內部應用資料。實際整合方式可依既有系統架構、資料權限及業務流程進行規劃。