OAuth Server-zu-Server-Authentifizierung

Die OAuth Server-zu-Server-Authentifizierung ermöglicht den sicheren, Token-basierten Zugriff auf AEM Forms Communications-APIs, ohne dass eine Benutzerinteraktion erforderlich ist. Die OAuth-Server-zu-Server-Authentifizierung wird von Adobe Developer Console unterstützt.

Voraussetzungen

Bevor Sie beginnen, stellen Sie sicher, dass die folgenden Voraussetzungen erfüllt sind:

Wie wird ein Zugriffs-Token mithilfe der OAuth-Server-zu-Server-Authentifizierung generiert?

Gehen Sie wie folgt vor, um ein Zugriffstoken von der Adobe Developer-Konsole aus zu generieren und Ihren ersten API-Aufruf über OAuth-Server-zu-Server-Authentifizierung durchzuführen.

​1. Adobe Developer Console-Projekteinrichtung

  1. Navigieren Sie zu Adobe Developer Console

  2. Mit Adobe ID anmelden

  3. Neues Projekt erstellen oder zu Ihrem vorhandenen Projekt navigieren

So erstellen Sie ein neues Projekt
  1. Klicken Sie Abschnitt „Schnellstart auf Neues Projekt erstellen

  2. Ein neues Projekt wird mit einem Standardnamen erstellt

    ADC-Projekt erstellen

  3. Klicken oben auf „Projekt bearbeiten“

    Projekt bearbeiten

  4. Geben Sie einen aussagekräftigen Namen an (z. B. „FormsProject„)

  5. Klicken Sie auf Speichern.

    Projektname bearbeiten

So navigieren Sie zu Ihrem vorhandenen Projekt
  1. Klicken Sie Adobe Developer Console auf Alle Projekte“

    Projekte suchen

  2. Suchen Sie Ihr Projekt und klicken Sie darauf, um es zu öffnen.

    Projekte suchen

​2. Hinzufügen von Forms-APIs

Fügen Sie Forms-APIs hinzu, je nachdem, was Sie tun möchten:

  • AEM Forms Communications APIs: Wird verwendet, wenn Sie Dokumente (PDF und zugehörige Formate) generieren, konvertieren, zusammenstellen oder sichern müssen.
  • Adaptive Forms Runtime-APIs - Wird verwendet, wenn Sie adaptive Forms zur Laufzeit rendern, übermitteln oder verarbeiten müssen.
Für AEM Forms Communications-APIs
  1. Klicken Sie auf API hinzufügen

    API hinzufügen

  2. Forms-Kommunikations-APIs

    1. Filtern im Dialogfeld „API" nach Experience Cloud

    2. Wählen Sie Forms-Kommunikations-APIs“

      Forms-Kommunikations-API hinzufügen

    3. Klicken Sie auf Weiter.

    4. Wählen Sie OAuth Server-zu-Server Authentifizierungsmethode aus

      Authentifizierungsmethode auswählen

Für adaptive Forms Runtime-APIs
  1. Klicken Sie auf API hinzufügen

    API hinzufügen

  2. AEM Forms-Bereitstellungs- und Laufzeit-API auswählen

    1. Filtern im Dialogfeld „API" nach Experience Cloud

    2. Wählen Sie AEM Forms-Bereitstellungs- und Laufzeit-API“
      Forms-Kommunikations-API hinzufügen

    3. Klicken Sie auf Weiter.

    4. Wählen Sie die Authentifizierungsmethode OAuth-Server-zu-Server aus.
      Authentifizierungsmethode auswählen

Sie können die API und die Authentifizierungsmethode auch zu Ihrem vorhandenen Projekt hinzufügen, indem Sie auf Zum Projekt hinzufügen > API
API zu vorhandenem Projekt hinzufügen

​3. Produktprofil hinzufügen

Das Produktprofil stellt Berechtigungen (oder Autorisierung) für Anmeldeinformationen für den Zugriff auf die AEM-Ressourcen bereit.

  1. Wählen Sie das Produktprofil aus, das Ihrer AEM-Instanz-URL (https://Service Type -Environment Type-Program XXX-Environment XXX.adobeaemcloud.com) entspricht.

    • Service-Typ - gibt die Services oder Berechtigungen an, die mit der AEM-Instanz verknüpft sind

    • Umgebungstyp - gibt an, ob die Umgebung für den Autoren- oder Veröffentlichungs-Service ist

    • Programm XXX - identifiziert die Cloud Manager-Programm-ID.

    • Umgebung XXX - identifiziert die spezifische Umgebungs-ID innerhalb dieses Programms

    note note
    NOTE
    Produktprofile sind an eine bestimmte AEM-Instanz (Programm + Umgebung) gebunden. Wählen Sie immer das Profil aus, das Ihrer Instanz-URL entspricht.
  2. Klicken Sie auf Konfigurierte API speichern. Die API und das Produktprofil werden zu Ihrem Projekt hinzugefügt

    Projektkonfiguration auswählen

​4. Erstellen und Speichern von Anmeldeinformationen

  1. Navigieren Sie zu Ihrem Projekt in Adobe Developer Console

  2. Klicken Sie auf OAuth Server-zu-Server Anmeldedaten

  3. Sehen Sie sich den Abschnitt Anmeldedaten an

    Anzeigen der Anmeldeinformationen

API-Anmeldeinformationen aufzeichnen

    API Credentials:
    ================
    Client ID: <your_client_id>
    Client Secret: <your_client_secret>
    Technical Account ID: <tech_account_id>
    Organization ID: <org_id>
    Scopes: AdobeID,openid,read_organizations

​5. Erzeugung von Zugriffstoken

Erstellen Sie das Zugriffstoken entweder manuell oder programmgesteuert:

Zum Testen

Manuelles Generieren von Zugriffs-Token in Adobe Developer Console:

  1. Navigieren Sie zu Ihrem Projekt

    1. Öffnen Sie in Adobe Developer Console Ihr Projekt
    2. Klicken Sie auf OAuth Server-zu-Server
  2. Zugriffs-Token generieren

    1. Klicken Sie im API-Abschnitt Ihres Projekts auf Schaltfläche Zugriffs-Token generieren“.
    2. Kopieren des generierten Zugriffstokens

    Zugriffs-Token generieren

    note note
    NOTE
    Das Zugriffs-Token ist nur für 24 Stunden gültig
Für die Produktion

Programmgesteuerte Generierung von Token mithilfe Adobe IMS-API:

Erforderliche Anmeldedaten:

  • Client-ID
  • Client-Geheimnis
  • Bereiche (typischerweise: openid, AdobeID, read_organizations, additional_info.projectedProductContext, read_pc.dma_aem_cloud, aem.document)

Token-Endpunkt:

code language-none
https://ims-na1.adobelogin.com/ims/token/v3

Beispielanfrage (curl):

code language-bash
curl -X POST 'https://ims-na1.adobelogin.com/ims/token/v3' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'grant_type=client_credentials' \
-d 'client_id=<YOUR_CLIENT_ID>' \
-d 'client_secret=<YOUR_CLIENT_SECRET>' \
-d 'scope=AdobeID,openid,read_organizations'

Antwort:

code language-json
    {
    "access_token": "eyJhbGciOiJSUz...",
    "token_type": "bearer",
    "expires_in": 86399
    }

Sie können jetzt das generierte Zugriffstoken verwenden, um API-Aufrufe für Entwicklungs-, Staging- oder Produktionsumgebungen durchzuführen.

Best Practices: Verwalten von Anmeldeinformationen für Entwicklung, Staging und Produktion

  • Verwenden Sie immer separate Anmeldeinformationen für Entwicklung, Staging und Produktion.

  • Ordnen Sie jede Berechtigung der richtigen AEM-Umgebungs-URL zu.

  • Geheime Daten sicher speichern und niemals in die Quell-Code-Verwaltung übertragen.

  • Verfolgen Sie die Gültigkeit des Zugriffs-Tokens, da Token nur für 24 Stunden gültig sind.

Nächste Schritte

Informationen zum Einrichten einer Umgebung für synchrone Forms-Kommunikations-APIs finden Sie unter Synchrone Verarbeitung von AEM Forms as a Cloud Service Communications.

Verwandte Artikel

Erfahren Sie, wie Sie eine Umgebung für synchrone (On-Demand) und asynchrone (Batch) Forms Communications-APIs einrichten:

Synchrone APIs

AEM Forms-Kommunikations-APIs - synchron

Erfahren Sie, wie Sie eine Umgebung für synchrone (On-Demand) Forms Communications-APIs einrichten, die Dokumente sofort generieren oder verarbeiten.

Weitere Informationen

Asynchrone APIs

AEM Forms Communications APIs - asynchron (Batch)

Erfahren Sie, wie Sie eine Umgebung für asynchrone (Batch-)Forms Communications-APIs einrichten, die mehrere Dokumente nach einem Zeitplan generieren oder verarbeiten.

Weitere Informationen

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab