DokumentationAEMAEM-TutorialsTutorials zu AEM as a Cloud Service

Einrichten von OpenAPI-basierten AEM-APIs

Last update: Tue Jul 01 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Gilt für:
  • Experience Manager as a Cloud Service

Erstellt für:

  • Einsteiger
  • Entwickler
  • Führungskraft

Erfahren Sie, wie Sie Ihre AEM as a Cloud Service-Umgebung einrichten, um den Zugriff auf OpenAPI-basierte AEM-APIs zu aktivieren.

In diesem Beispiel wird das AEM Assets-API unter Verwendung der Server-zu-Server-Authentifizierungsmethode verwendet, um den Einrichtungsprozess zu demonstrieren. Die gleichen Schritte können für andere OpenAPI-basierte AEM-APIs ausgeführt werden.

https://video.tv.adobe.com/v/3457510?quality=12&learn=on

Der allgemeine Einrichtungsprozess umfasst die folgenden Schritte:

  1. Modernisieren der AEM as a Cloud Service-Umgebung
  2. Aktivieren des AEM-API-Zugriffs
  3. Erstellen eines Adobe Developer Console(ADC)-Projekts
  4. Konfigurieren des ADC-Projekts
  5. Konfigurieren der AEM-Instanz zur Aktivierung der ADC-Projektkommunikation

Modernisieren der AEM as a Cloud Service-Umgebung modernization-of-aem-as-a-cloud-service-environment

Die Modernisierung der AEM as a Cloud Service-Umgebung ist eine einmalige Aktivität pro Umgebung, die die folgenden Schritte vorsieht:

  • Aktualisieren auf die AEM-Version 2024.10.18459.20241031T210302Z oder höher
  • Hinzufügen neuer Produktprofile, wenn die Umgebung vor der Version 2024.10.18459.20241031T210302Z erstellt wurde

Aktualisieren der AEM-Instanz update-aem-instance

Um die AEM-Instanz zu aktualisieren, wählen Sie im Abschnitt Umgebungen von Adobe Cloud Manager das Symbol mit den Auslassungspunkten neben dem Umgebungsnamen und dann die Option Aktualisieren aus.

Aktualisieren der AEM-Instanz

Klicken Sie anschließend auf die Schaltfläche Absenden und führen Sie die vorgeschlagene Fullstack-Pipeline aus.

Auswählen der neuesten AEM-Version

Im vorliegenden Fall heißt die Fullstack-Pipeline Dev :: Fullstack-Deploy und die AEM-Umgebung wknd-program-dev. Bei Ihnen lauten die Namen womöglich anders.

Hinzufügen neuer Produktprofile add-new-product-profiles

Um der AEM-Instanz neue Produktprofile hinzuzufügen, wählen Sie im Abschnitt Umgebungen von Adobe Cloud Manager das Symbol mit den Auslassungspunkten neben dem Umgebungsnamen und dann die Option Produktprofile hinzufügen aus.

Hinzufügen neuer Produktprofile

Sie können die neu hinzugefügten Produktprofile überprüfen, indem Sie auf das Symbol mit den Auslassungspunkten neben dem Umgebungsnamen klicken und Zugriff verwalten > Autorenprofile auswählen.

Im Fenster Admin Console werden die neu hinzugefügten Produktprofile angezeigt.

Überprüfen neuer Produktprofile

Mit den oben genannten Schritten wird die Modernisierung der AEM as a Cloud Service-Umgebung abgeschlossen.

Aktivieren des AEM-API-Zugriffs enable-aem-apis-access

Die vorhandenen neuen Produktprofile ermöglichen den OpenAPI-basierten Zugriff auf AEM-APIs in der Adobe Developer Console (ADC). Denken Sie daran, dass die Adobe Developer Console (ADC) der Entwicklungs-Hub für den Zugriff auf Adobe-APIs, SDKs, Echtzeitereignisse, Server-lose Funktionen usw. ist.

Die neu hinzugefügten Produktprofile sind mit den Services verknüpft, die AEM-Benutzergruppen mit vordefinierten Zugriffssteuerungslisten (Access Control Lists, ACLs) darstellen. Die Services werden verwendet, um die Zugriffsebene auf die AEM-APIs zu steuern.

Sie können auch die mit dem Produktprofil verknüpften Services aus- oder abwählen, um die Zugriffsebene herab- oder heraufzusetzen.

Überprüfen Sie die Verknüpfung, indem Sie neben dem Namen des Produktprofils auf das Symbol Details anzeigen klicken.

Überprüfen der mit dem Produktprofil verknüpften Services

Aktivieren des AEM Assets-API-Zugriffs enable-aem-assets-apis-access

Standardmäßig ist der Service für AEM Assets-API-Benutzende mit keinem Produktprofil verknüpft. Verknüpfen Sie ihn mit dem neu hinzugefügten Produktprofil für AEM Assets-Mitarbeiter-Benutzende – Autorin/Autor – Programm XXX – Umgebung XXX oder jedem anderen Produktprofil, das Sie für den Zugriff auf die AEM Assets-API verwenden möchten.

Verknüpfen des AEM Assets-API-Benutzer-Service mit dem Produktprofil

Aktivieren der Server-zu-Server-Authentifizierung

Um die Server-zu-Server-Authentifizierung für die gewünschten AEM-APIs zu aktivieren, müssen die Benutzenden, die die Integration mit Adobe Developer Console (ADC) einrichten, dem mit dem Dienst verknüpften Produktprofil als Entwickelnde hinzugefügt werden.

Um beispielsweise die Server-zu-Server-Authentifizierung für die AEM Assets-API zu aktivieren, müssen die Benutzenden dem Produktprofil AEM Assets-Mitarbeiter-Benutzende – Autorin/Autor – Programm XXX – Umgebung XXX als Entwickelnde hinzugefügt werden.

Verknüpfen von Entwickelnden mit Produktprofil

Nach dieser Verknüpfung kann das Asset Author-API des ADC-Projekts die gewünschte Server-zu-Server-Authentifizierung einrichten und das Authentifizierungskonto aus dem (im nächsten Schritt erstellten) ADC-Projekt dem Produktprofil zuordnen.

IMPORTANT
Der obige Schritt ist wichtig, um die Server-zu-Server-Authentifizierung für das gewünschte AEM Assets-API zu aktivieren. Ohne diese Verknüpfung kann das AEM-API nicht mit der Server-zu-Server-Authentifizierungsmethode verwendet werden.

Erstellen eines Adobe Developer Console(ADC)-Projekts adc-project

Das ADC-Projekt wird verwendet, um die gewünschten APIs hinzuzufügen, die zugehörige Authentifizierung einzurichten und das Authentifizierungskonto mit dem Produktprofil zu verknüpfen.

So erstellen Sie ein ADC-Projekt:

  1. Melden Sie sich mit Ihrer Adobe ID bei der Adobe Developer Console an.

    Adobe Developer Console

  2. Klicken Sie im Abschnitt Quick Start (Schnellstart) auf die Schaltfläche Create new project (Neues Projekt erstellen).

    Erstellen eines neuen Projekts

  3. Es wird ein neues Projekt mit dem Standardnamen erstellt.

    Neues Projekt erstellt

  4. Bearbeiten Sie den Projektnamen, indem Sie oben rechts auf die Schaltfläche Edit project (Projekt bearbeiten) klicken. Geben Sie einen aussagekräftigen Namen ein und klicken Sie auf Save (Speichern).

    Bearbeiten des Projektnamens

Konfigurieren des ADC-Projekts configure-adc-project

Nachdem Sie das ADC-Projekt erstellt haben, müssen Sie die gewünschten AEM-APIs hinzufügen, die zugehörige Authentifizierung einrichten und das Authentifizierungskonto mit dem Produktprofil verknüpfen.

  1. Um AEM-APIs hinzuzufügen, klicken Sie auf die Schaltfläche Add API (API hinzufügen).

    Hinzufügen des APIs

  2. Filtern Sie im Dialogfeld Add an API (API hinzufügen) auf Experience Cloud und wählen Sie das gewünschte AEM-API aus. In diesem Fall ist beispielsweise das Asset Author-API ausgewählt.

    Hinzufügen eines AEM-APIs

    note tip
    TIP
    Wenn die gewünschte AEM-API-Karte deaktiviert ist und in den Informationen für Warum ist dies deaktiviert? die Meldung Lizenz erforderlich angezeigt wird, könnte dies daran liegen, dass Sie Ihre AEM as a Cloud Service-Umgebung NICHT modernisiert haben. Weitere Informationen finden Sie unter Modernisieren der AEM as a Cloud Service-Umgebung.

  3. Wählen Sie anschließend im Dialogfeld Configure API (API konfigurieren) die gewünschte Authentifizierungsoption aus. In diesem Fall ist beispielsweise die Option zur Server-zu-Server-Authentifizierung ausgewählt.

    Auswählen der Authentifizierung

    Die Server-zu-Server-Authentifizierung ist ideal für Backend-Services, die API-Zugriff ohne Benutzerinteraktion benötigen. Die Authentifizierungsoptionen für Web-Anwendungen und Single Page Applications eignen sich für Anwendungen, die API-Zugriff im Namen von Benutzenden benötigen. Weitere Informationen finden Sie unter Unterschied zwischen OAuth-Server-zu-Server-, Web-Anwendungs- und Single-Page-Application-Anmeldedaten.

    note tip
    TIP
    Wenn die Option für die Server-zu-Server-Authentifizierung nicht angezeigt wird, bedeutet dies, dass die Benutzenden, die die Integration einrichten, nicht als Entwickelnde zu dem mit dem Dienst verknüpften Produktprofil hinzugefügt werden. Weitere Informationen finden Sie unter Aktivieren der Server-zu-Server-Authentifizierung.

  4. Bei Bedarf können Sie das API umbenennen, um eine einfachere Identifizierung zu ermöglichen. Zu Demozwecken wird der Standardname verwendet.

    Umbenennen der Anmeldedaten

  5. In diesem Fall wird die OAuth-Server-zu-Server-Authentifizierungsmethode verwendet. Daher müssen Sie das Authentifizierungskonto mit dem Produktprofil verknüpfen. Wählen Sie das Produktprofil für AEM Assets-Mitarbeiter-Benutzende – Autorin/Autor – Programm XXX – Umgebung XXX aus und klicken Sie auf Save (Speichern).

    Auswählen des Produktprofils

  6. Überprüfen Sie das AEM-API und die Authentifizierungskonfiguration.

    AEM-API-Konfiguration

    Authentifizierungskonfiguration

Wenn Sie die Authentifizierungsmethode OAuth Web App (OAuth-Web-Anwendung) oder OAuth Single Page App (OAuth-Single-Page-Application) wählen, wird nicht zur Produktprofilzuordnung aufgerufen, aber der Umleitungs-URI der Anwendung ist erforderlich. Der Umleitungs-URI der Anwendung wird verwendet, um Benutzende nach der Authentifizierung mit einem Autorisierungs-Code an die Anwendung umzuleiten. In den entsprechenden Tutorials zu den Anwendungsfällen werden solche authentifizierungsspezifischen Konfigurationen beschrieben.

Konfigurieren der AEM-Instanz zur Aktivierung der ADC-Projektkommunikation configure-aem-instance

Um die Client-ID des ADC-Projekts für die Kommunikation mit der AEM-Instanz zu aktivieren, müssen Sie die AEM-Instanz konfigurieren.

Definieren Sie hierzu die API-Konfiguration in einer YAML-Datei und stellen Sie sie mithilfe der Konfigurations-Pipeline in Cloud Manager bereit. Die YAML-Datei definiert die zulässigen Client-IDs aus dem ADC-Projekt, die mit der AEM-Instanz kommunizieren können.

  1. Suchen Sie im AEM-Projekt im Ordner config nach der Datei api.yaml oder erstellen Sie diese.

    Suchen nach API YAML {width="500"}

  2. Fügen Sie der Datei api.yaml die folgende Konfiguration hinzu:

    code language-yaml 
    kind: "API"
version: "1.0"
metadata:
    envTypes: ["dev", "stage", "prod"]
data:
    allowedClientIDs:
        author:
        - "<ADC Project's Credentials ClientID>"

    Ersetzen Sie <ADC Project's Credentials ClientID> durch die tatsächliche Client-ID der Anmeldedaten des ADC-Projekts. Der in diesem Tutorial verwendete API-Endpunkt ist nur auf der Erstellungsebene verfügbar. Bei anderen APIs kann die YAML-Konfiguration auch über einen Knoten publish oder preview verfügen.

    note caution
    CAUTION
    Zu Demozwecken wird für alle Umgebungen dieselbe Client-ID verwendet. Es wird empfohlen, für mehr Sicherheit und Kontrolle eine separate Client-ID pro Umgebung (Entwicklung, Staging, Produktion) zu verwenden.

  3. Übergeben Sie die Konfigurationsänderungen und pushen Sie die Änderungen an das Remote-Git-Repository, mit dem die Cloud Manager-Pipeline verbunden ist.

  4. Stellen Sie die oben genannten Änderungen mithilfe der Konfigurations-Pipeline in Cloud Manager bereit. Beachten Sie, dass die Datei api.yaml mithilfe von Befehlszeilenprogrammen auch in einer schnellen Entwicklungsumgebung installiert werden kann.

    Bereitstellen der YAML-Datei

Nächste Schritte

Sobald die AEM-Instanz so konfiguriert ist, dass die ADC-Projektkommunikation aktiviert wird, können Sie die OpenAPI-basierten AEM-APIs verwenden. Erfahren Sie, wie Sie die OpenAPI-basierten AEM-APIs mit verschiedenen OAuth-Authentifizierungsmethoden verwenden:

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 Single-Page-Application-Authentifizierung

Aufrufen des APIs mit Single-Page-Application-Authentifizierung

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

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