AEM API概述 aem-apis-overview

瞭解Adobe Experience Manager (AEM)中的各種API,並瞭解為您的整合選擇哪種API。

若要在AEM中建立、讀取、更新及刪除內容、資產和表單,開發人員可使用各式各樣的API。 這些API可讓開發人員建立與AEM互動的自訂應用程式。

讓我們探索AEM中的不同API型別,並瞭解為您的整合選擇哪種API。

AEM API的型別 types-of-aem-apis

AEM提供下列API,以便與其作者和發佈服務型別互動。

AEM API型別
描述
可用性
使用案例
API範例
OpenAPI型AEM API
適用於Assets、Sites和Forms的標準化機器可讀API。
僅限AEM as a Cloud Service
API優先開發,現代應用程式
Assets作者API資料夾APIAEM Sites APIForms檔案服務API及其他
RESTful API
與AEM資源互動的傳統REST端點。
AEM 6.X、AEM as a Cloud Service
CRUD作業,現代應用程式
Assets HTTP API工作流程REST API內容服務的JSON匯出工具及其他
GRAPHQL API
透過彈性的查詢,針對有效擷取結構化內容進行最佳化。
AEM 6.X、AEM as a Cloud Service
Headless CMS、SPA、行動應用程式
GraphQL API
傳統(非RESTful) API
JCR、Sling模型、查詢產生器等較舊的API。
AEM 6.X、AEM as a Cloud Service
舊版整合、回溯相容性
查詢產生器API及其他

如需詳細資訊,請參閱Adobe Experience Manager as a Cloud Service API頁面。

要選擇哪個API which-api-to-choose

為您的整合選取API時,請考慮下列因素:

  • 使用案例:判斷AEM API是否支援您的使用案例。 儘可能使用OpenAPI式AEM API ,因為這些API提供與AEM互動的標準化現代方法。​如果無法使用OpenAPI型API,請考慮使用RESTful API或GraphQL API,作為最後的手段,使用傳統API。

  • 相容性:確定選取的API與您的AEM版本相容。 例如,OpenAPI型AEM API是AEM as a Cloud Service​的專屬專案,無法在AEM 6.X中使用。

  • AEM服務型別: Author與Publish:API的選擇也取決於它是在Author或Publish服務上執行,因為它們的存取模型不同。 AEM Author服務是用於內容建立,一律需要驗證。 AEM Publish服務用於內容傳送,且可能不需要驗證,端視使用案例而定。

  • 驗證:確認API支援您打算使用的驗證方法。 例如:

    • 以OpenAPI為基礎的AEM API:支援OAuth 2.0驗證,包括使用者端認證(伺服器對伺服器)、授權代碼(網頁應用程式)以及代碼交換(單頁應用程式)授權型別的證明金鑰。 其他AEM API不支援OAuth 2.0驗證。
    • RESTful API:支援JSON Web權杖(JWT)驗證,也稱為權杖型驗證。

JSON Web權杖(JWT)和OAuth 2.0之間的差異 difference-between-jwt-and-oauth

讓我們比較JSON Web權杖(JWT)和OAuth 2.0,AEM API中使用的兩種常見驗證機制:

功能
JSON Web權杖(JWT)
OAuth 2.0
使用位置
RESTful API
以OpenAPI為基礎的AEM API (RESTful或其他API不支援)
用途
服務驗證
使用者或服務驗證
使用者互動
不需要使用者互動
授權代碼和單頁應用程式授予型別所需的使用者互動
最適合
伺服器對伺服器API呼叫
安全且許可的應用程式和使用者存取
必要資訊
簽署JWT的私密金鑰
OAuth 2.0的使用者端ID和使用者端密碼
權杖到期
期限短,通常需要重新整理
存取權杖為短期。 refresh-token是長效的,用於取得新的存取 — token
認證管理
AEM Developer Console
Adobe Developer Console

OpenAPI型AEM API

OpenAPI-based AEM API指南中進一步瞭解OpenAPI-based AEM API和存取Adobe API的重要概念。

使用案例

使用伺服器對伺服器驗證叫用API

使用伺服器對伺服器驗證啟動API

瞭解如何使用OAuth伺服器對伺服器驗證,從自訂NodeJS應用程式叫用OpenAPI型AEM API。

了解更多

使用網頁應用程式驗證叫用API

使用網頁應用程式驗證啟動API

瞭解如何使用OAuth網頁應用程式驗證,從自訂網頁應用程式叫用OpenAPI型AEM API。

了解更多

使用OAuth單頁應用程式叫用API

使用OAuth單頁應用程式叫用API

瞭解如何使用OAuth 2.0 PKCE流程,從自訂單頁應用程式(SPA)叫用OpenAPI型AEM API。

了解更多

GraphQL API — 範例

AEM Headless快速入門 — GraphQL中進一步瞭解GraphQL API以及如何使用

使用案例

單頁應用程式(SPA)

單頁應用程式(SPA)

瞭解如何使用GraphQL API建立可從AEM擷取內容的單頁應用程式(SPA)。

了解更多

行動應用程式

行動應用程式

瞭解如何使用GraphQL API建立從AEM擷取內容的行動應用程式。

了解更多

Web元件

網頁元件

瞭解如何使用GraphQL API建置可從AEM擷取內容的網頁元件。

了解更多

RESTful API — 範例

深入瞭解RESTful API,例如Assets HTTP APIJSON匯出工具

使用案例

針對Headless應用程式使用Content Services

使用Headless應用程式的內容服務

瞭解如何使用Content Services RESTful API建立可從AEM擷取內容的原生行動應用程式。

了解更多

RESTful API的權杖型驗證

RESTful API的權杖型驗證

瞭解如何使用JSON Web權杖(JWT)驗證來叫用RESTful API。

了解更多

recommendation-more-help
4859a77c-7971-4ac9-8f5c-4260823c6f69