Überblick über AEM-APIs aem-apis-overview

Erfahren Sie mehr über die verschiedenen API-Typen in Adobe Experience Manager (AEM) und die Auswahl des richtigen APIs für Ihre Integration.

Zum Erstellen, Lesen, Aktualisieren und Löschen von Inhalten, Assets und Formularen in AEM können Entwickelnde eine Vielzahl von APIs verwenden. Diese APIs ermöglichen es Entwickelnden, benutzerdefinierte Programme zu erstellen, die mit AEM interagieren.

Im Folgenden werden die verschiedenen API-Typen in AEM vorgestellt und erklärt, welches API für Ihre Integration ausgewählt werden sollte.

Typen von AEM-APIs types-of-aem-apis

AEM bietet folgende APIs zur Interaktion mit zugehörigen Autoren- und Veröffentlichungs-Service-Typen.

AEM-API-Typ
Beschreibung
Verfügbarkeit
Anwendungsfall
API-Beispiele
OpenAPI-basierte AEM-APIs
Standardisierte, maschinenlesbare APIs für Assets, Sites und Forms
Nur AEM as a Cloud Service
API-First-Entwicklung, moderne Anwendungen
Assets Author-API, Folders-API, AEM Sites-API, Forms Document Services-API und andere
RESTful-APIs
Herkömmliche REST-Endpunkte zur Interaktion mit AEM-Ressourcen
AEM 6.X, AEM as a Cloud Service
CRUD-Vorgänge, moderne Anwendungen
Assets HTTP-API, Workflow REST-API, JSON-Exporter für Content Services und andere
GraphQL-APIs
Optimiert für effizientes Abrufen strukturierter Inhalte mit flexiblen Abfragen
AEM 6.X, AEM as a Cloud Service
Headless-CMS, SPAs, Apps
GraphQL-API
Herkömmliche (Nicht-RESTful-)APIs
Ältere APIs wie JCR, Sling-Modelle, Query Builder und andere
AEM 6.X, AEM as a Cloud Service
Ältere Integrationen, Abwärtskompatibilität
Query Builder-API und andere

Weitere Informationen finden Sie auf der Seite Adobe Experience Manager as a Cloud Service-APIs.

Auswählen des richtigen APIs which-api-to-choose

Beachten Sie bei der Auswahl eines APIs für Ihre Integration die folgenden Faktoren:

  • Anwendungsfall: Ermitteln Sie, ob das AEM-API Ihren Anwendungsfall unterstützt. Verwenden Sie nach Möglichkeit OpenAPI-basierte AEM-APIs, da sie einen standardisierten, modernen Ansatz für die Interaktion mit AEM bieten. Wenn keine OpenAPI-basierten APIs verfügbar sind, sollten Sie sich für RESTful- oder GraphQL-APIs und als letzte Option für herkömmliche APIs entscheiden.

  • Kompatibilität: Stellen Sie sicher, dass das ausgewählte API mit Ihrer AEM-Version kompatibel ist. Beispielsweise sind OpenAPI-basierte AEM-APIs AEM as a Cloud Service vorbehalten und nicht in AEM 6.X verfügbar.

  • AEM-Service-Typ („Author“ oder „Publish“): Die Auswahl des APIs hängt auch davon ab, ob sie im Rahmen des AEM Author- oder AEM Publish-Service ausgeführt werden, da diese unterschiedliche Zugriffsmodelle aufweisen. Der AEM Author-Service wird zur Inhaltserstellung verwendet und erfordert immer eine Authentifizierung. Der AEM Publish-Service wird zur Bereitstellung von Inhalten verwendet und erfordert je nach Anwendungsfall möglicherweise keine Authentifizierung.

  • Authentifizierung: Stellen Sie sicher, dass das API die gewünschte Authentifizierungsmethode unterstützt. Zum Beispiel:

    • OpenAPI-basierte AEM-APIs unterstützen die OAuth 2.0-Authentifizierung, einschließlich der Grant-Tpen Client-Anmeldedaten (Server-zu-Server), Autorisierungs-Code (Web-Anwendung) und PKCE (Single Page Application). Andere AEM-APIs unterstützen nicht die OAuth 2.0-Authentifizierung.
    • RESTful-APIs unterstützen die JSON-Web-Token(JWT)-Authentifizierung und werden auch als Token-basierte Authentifizierung bezeichnet.

Unterschied zwischen JSON-Web-Token (JWT) und OAuth 2.0 difference-between-jwt-and-oauth

Im Folgenden finden Sie einen Vergleich zwischen JSON-Web-Token (JWT) und OAuth 2.0, zwei gängigen in AEM-APIs verwendeten Authentifizierungsmechanismen:

Funktion
JSON-Web-Token (JWT)
OAuth 2.0
Verwendung
RESTful-APIs
OpenAPI-basierte AEM-APIs (in RESTful- oder anderen APIs nicht unterstützt)
Zweck
Service-Authentifizierung
Benutzer- oder Service-Authentifizierung
Benutzerinteraktion
Keine Benutzerinteraktion erforderlich
Benutzerinteraktion für die Grant-Typen Autorisierungs-Code und Single Page Application erforderlich
Optimal für
Server-zu-Server-API-Aufrufe
Sicherer, zulässiger Zugriff für Anwendungen und Benutzende
Erforderliche Informationen
Private Key zur JWT-Signatur
Client-ID und Client-Geheimnis für OAuth 2.0
Token-Ablauf
Kurzlebig, muss oft aktualisiert werden
Kurzlebiges Zugriffs-Token; langlebiges Aktualisierungs-Token, das zum Abrufen eines neuen Zugriffs-Tokens verwendet wird
Anmeldedaten-Management
AEM Developer Console
Adobe Developer Console

OpenAPI-basierte AEM-APIs

Weitere Informationen zu OpenAPI-basierten AEM-APIs und wichtigen Konzepte für den Zugriff auf Adobe-APIs finden Sie im Handbuch zu OpenAPI-basierten AEM-APIs.

Anwendungsfälle

Aufrufen des APIs mit Server-zu-Server-Authentifizierung

Aufrufen des APIs mit Server-zu-Server-Authentifizierung

Erfahren Sie, wie Sie OpenAPI-basierte AEM-APIs aus einer benutzerdefinierten NodeJS-Anwendung mithilfe der OAuth-Server-zu-Server-Authentifizierung aufrufen.

Mehr erfahren

Aufrufen des APIs mit Web-Anwendungs-Authentifizierung

Aufrufen des APIs mit Web-Anwendungs-Authentifizierung

Erfahren Sie, wie Sie OpenAPI-basierte AEM-APIs aus einer benutzerdefinierten Web-Anwendung mithilfe der OAuth-Web-Anwendungs-Authentifizierung aufrufen.

Mehr erfahren

Aufrufen des APIs mit OAuth-Single-Page-Application

Aufrufen des APIs mit OAuth-Single-Page-Application

Erfahren Sie, wie Sie OpenAPI-basierte AEM-APIs aus einer benutzerdefinierten Single Page Application (SPA) mithilfe des OAuth 2.0 PKCE-Flusses aufrufen.

Mehr erfahren

GraphQL-APIs – Beispiele

Weitere Informationen zu den GraphQL-APIs und deren Verwendung finden Sie unter Erste Schritte mit AEM Headless – GraphQL.

Anwendungsfälle

Single Page Application (SPA)

Single Page Application (SPA)

Erfahren Sie, wie Sie mithilfe von GraphQL-APIs eine Single Page Application (SPA) erstellen, die Inhalte aus AEM abruft.

Mehr erfahren

App

App

Erfahren Sie, wie Sie mithilfe von GraphQL-APIs eine App erstellen, die Inhalte aus AEM abruft.

Mehr erfahren

Web-Komponente

Web-Komponente

Erfahren Sie, wie Sie mithilfe von GraphQL-APIs eine Web-Komponente erstellen, die Inhalte aus AEM abruft.

Mehr erfahren

RESTful-APIs – Beispiele

Erfahren Sie mehr über RESTful-APIs, z. B. Assets HTTP-API und JSON-Exporter.

Anwendungsfälle

Verwenden von Content Services für die Headless-Anwendung

Verwenden von Content Services für die Headless-Anwendung

Erfahren Sie, wie Sie mithilfe von Content Services-RESTful-APIs eine native App erstellen, die Inhalte aus AEM abruft.

Mehr erfahren

Token-basierte Authentifizierung für RESTful-APIs

Token-basierte Authentifizierung für RESTful-APIs

Erfahren Sie, wie Sie RESTful-APIs mithilfe der JSON-WebToken(JWT)-Authentifizierung aufrufen.

Mehr erfahren

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