OpenAPI-basierte APIs

Letzte Aktualisierung: 15. Mai 2025
  • Gilt für:
  • Experience Manager as a Cloud Service

Erstellt für:

  • Admin
  • Entwickler

Neuere AEM as a Cloud Service-APIs folgen der OpenAPI-Spezifikation und bieten daher einen konsistenten und gut dokumentierten Satz von APIs.

HINWEIS
Ein -Tutorial ist eineRessource, in der Sie erfahren, wie Sie die OpenAPI-basierten AEM-APIs konfigurieren und aufrufen können.

Bei Endpunkten, für die eine Authentifizierung erforderlich ist, unterscheidet sich der Authentifizierungsansatz je nach Endpunkt, verwendet jedoch möglicherweise OAuth Server-zu-Server, OAuth Web App oder OAuth Single Page App (SPA). Anmeldeinformationen werden über Projekte in Adobe Developer Console konfiguriert.

Häufige API-Anwendungsfälle umfassen Integrationen mit Systemen wie CRM oder PIM, bei denen AEM-APIs aufgerufen werden, um Daten abzurufen oder beizubehalten. Im Rahmen der Integrationsimplementierung können Anwendungen von AEM ausgelöste Ereignisse abonnieren, wodurch Geschäftslogik in Adobe App Builder oder einer anderen Infrastruktur Trigger werden kann.

Dieses Dokument dient als Übersicht, eine ausführlichere Dokumentation ist jedoch auf den folgenden Seiten verfügbar:

  • Die Links aus dem Abschnitt zur OpenAPI-basierten API in Referenzdokumentation. Die Referenzdokumentation jeder API enthält auch einen API-Playground, mit dem Sie einen Endpunkt einfach mithilfe eines mit der Adobe Developer Console generierten Bearer-Tokens ausprobieren können.

  • Informative Handbücher einschließlich API-Konzepte und -Syntax.

  • Ein Tutorial auf oberster Ebene, in dem Authentifizierungsansätze und andere Konzepte beschrieben werden.

  • Ein Tutorial mit Video, das sich auf Konfiguration der OpenAPI-basierten APIs.

  • Ein Tutorial mit allen Schritten zum Konfigurieren und Aufrufen von OpenAPIs mit der Server-zu-Server-Authentifizierungsstrategie. Ähnliche Tutorials finden Sie auch für Authentifizierungsansätze für Web-Anwendungen und Einzelseiten-Apps.

API-Zugriff konfigurieren

Einige OpenAPI-basierte AEM-APIs müssen authentifiziert werden. Dazu müssen Anmeldeinformationen mithilfe von Adobe Developer Console generiert. Die Konfiguration umfasst die folgenden Schritte:

  1. Modernisierung der AEM as a Cloud Service-Umgebung.
  2. Aktivieren des Zugriffs auf die AEM-APIs mithilfe von Produktprofilen. Produktprofile sind mit den Services verknüpft, die AEM-Benutzergruppen mit vordefinierten Zugriffssteuerungslisten (ACLs) darstellen. Während einige Services standardmäßig bestimmten Produktprofilen zugeordnet sind, müssen andere explizit zugeordnet werden. Beispielsweise ist der AEM Assets-API-Benutzerdienst mit keinem Produktprofil verknüpft. Daher müssen Sie ihn für die Verwendung der AEM Assets-API aktivieren. Weitere Informationen finden Sie im TutorialSchritt „Zugriff auf AEMAPIs aktivieren“.
  3. Um die Server-zu-Server-Authentifizierung hinzuzufügen, muss die Benutzereinstellungsintegration der Systemadministrator des Unternehmens in der Adobe Admin Console sein oder dem Produktprofil, mit dem der Service verknüpft ist, als Entwickler hinzugefügt werden. Weitere Informationen finden Sie im TutorialSchritt „Zugriff auf AEMAPIs aktivieren“.
  4. Erstellen Sie ein Adobe Developer Console-Projekt (ADC).
  5. Konfigurieren Sie das ADC-Projekt. Dadurch werden Anmeldeinformationen generiert, die beim Aufrufen der API später zum Austausch gegen ein Bearer-Token verwendet werden.
  6. Konfigurieren Sie die AEM-Instanz, um die ADC-Projektkommunikation zu aktivieren. Dazu müssen Sie die Client-ID bei der Umgebung registrieren, indem Sie eine YAML-Datei konfigurieren und bereitstellen, wie im Abschnitt Registrieren einer Client-ID unten beschrieben.

Detaillierte schrittweise Anweisungen finden Sie im Tutorial Einrichten von OpenAPI-basierten APIs.