Liferay API 可協助企業將入口平台、內容管理、文件管理、會員帳號、權限資料與外部系統串接，支援前後端分離、行動 APP、企業系統整合與自動化流程應用。
在 Liferay 專案中，API 不只是提供資料查詢，也常被用於建立跨系統服務入口、外部網站資料串接、Client Extensions 前端應用、批次資料交換，以及 ERP、CRM、DMS、SRM 等企業系統整合。
Liferay API 主要類型
RESTful Headless APIs
適合前後端分離、行動 APP、外部網站與系統整合使用。常用於取得網站內容、文件、圖片、使用者、組織、站台與自訂物件資料。
GraphQL API
適合前端需要自行定義回傳欄位，或一次查詢多種關聯資料的情境，可減少不必要的資料回傳。
Client-side API 呼叫
適合 Client Extensions、Custom Elements、React、Vue、Angular 等前端應用，在 Liferay 頁面中呼叫平台 API。
JSON Web Services
Liferay 既有的 JSONWS 服務機制，可提供較底層的 Java Service 存取能力。新專案通常建議優先評估 Headless API。
什麼情境適合使用 Liferay API？
| 前後端分離開發 | 前端使用 React、Vue、Angular 或 Web Components 開發畫面，後端由 Liferay 提供內容、文件、權限、使用者與自訂資料服務。 |
|---|---|
| 行動 APP 串接 | APP 可透過 API 讀取公告、文件、知識文章、會員資料、待辦任務或特定業務資料，並依登入者權限顯示內容。 |
| 企業系統整合 | 將 Liferay 與 ERP、CRM、HR、DMS、SRM、BPM、會員系統或其他後端服務整合，建立一致的入口與資料交換機制。 |
| 與資料交換機制。 | |
| 批次資料同步 | 可用於使用者、組織、內容、文件、分類、標籤或自訂物件資料的匯入、匯出與同步作業。 |
REST API、GraphQL、JSONWS 怎麼選？
| REST API | 適合大多數整合情境。若需求是標準 CRUD、外部系統串接、APP 串接、內容或文件資料存取，通常可優先使用 REST Headless APIs。 |
|---|---|
| GraphQL | 適合前端畫面需要自行控制回傳欄位，或單一畫面需要組合多種資料來源時使用。但導入前仍需確認 API 可用範圍與維護方式。 |
| JSONWS | 適合既有系統、舊版 Liferay 專案，或 Headless API 尚未涵蓋的底層服務需求。新開發不建議一開始就直接依賴 JSONWS。 |
| 客製 API | 若標準 API 不符合資料格式、權限規則、交易流程或外部系統整合需求，可另外設計客製 REST API 或中介服務。 |
常見 API 入口與開發方式
- API Explorer：可透過 /o/api 檢視與測試 Liferay 可用的 REST API。
- GraphQL：可透過 /o/graphql 進行 GraphQL 查詢。
- JSONWS：可透過 /api/jsonws 查看既有 JSON Web Services。
- Client Extensions：前端應用可在 Liferay 頁面中呼叫 Headless API，建立更彈性的操作介面。
API 權限與安全注意事項
OAuth2 與存取範圍
- 依應用情境建立 OAuth2 Application
- 避免給予過大的 API 權限範圍
- 區分使用者操作與系統對系統的 API 呼叫
資料權限與角色控管
- 確認 API 回傳資料是否受到 Liferay 角色與權限控管
- 避免前端取得不應顯示的敏感資料
- 必要時建立中介 API，統一處理資料過濾與權限檢查
導入 Liferay API 前需要先確認什麼？
- 資料來源：資料是來自 Liferay 內容、文件、自訂物件，還是外部 ERP、CRM、HR、DMS 系統。
- 使用者身分：API 是代表登入者操作，還是由系統服務帳號執行。
- 權限規則：不同角色、組織、站台或群組是否有不同資料可見範圍。
- 資料量與效能：是否需要分頁、排序、篩選、快取或批次處理。
- 版本與維護：API 路徑、資料格式與前端應用需有版本控管，避免升級後影響既有整合。
景佳科技可協助內容
API 架構與整合規劃
- 評估適合使用 Headless API、GraphQL、JSONWS 或客製 API
- 規劃 OAuth2、SSO、權限控管與 API 存取流程
- 協助設計前後端分離與企業系統整合架構
開發與串接實作
- Liferay API 串接與客製服務開發
- React、Vue、Angular、Client Extensions 前端整合
- ERP、CRM、DMS、SRM、BPM 等企業系統 API 整合
需要規劃 Liferay API 整合架構？
若您的系統需要與 Liferay 進行前後端分離、行動 APP 串接、企業系統整合或跨平台資料交換，景佳科技可協助評估 API 架構、權限設計與開發實作方式。