Synchrone APIs für die Kommunikationsverarbeitung in AEM Forms as a Cloud Service

Bei Adobe Cloud Manager anmelden

1. Navigieren Sie zu my.cloudmanager.adobe.com
2. Mit Adobe ID anmelden

Navigieren Sie zur Programmübersicht

1. Wählen Sie Ihr Programm aus der Liste aus. Sie werden zur Seite Programmübersicht weitergeleitet

Umgebungsdetails suchen

1. Wählen Sie das Symbol ellipsis(…) neben dem Umgebungsnamen aus und klicken Sie auf Aktualisieren

2. Klicken Sie auf Senden und führen Sie die vorgeschlagene Full-Stack-Pipeline aus.

   

Suchen Sie den Abschnitt Repository

1. Klicken Sie auf der Programmübersicht auf die Registerkarte Repositorys

2. Suchen Sie den Repository-Namen und klicken Sie auf das Menü mit den Auslassungspunkten (…)

3. Repository-URL kopieren

   note note
   NOTE
   Das URL-Format ist normalerweise https://git.cloudmanager.adobe.com/<org>/<program>/

Klonen mit dem Git-Befehl

1. Öffnen Sie die Eingabeaufforderung oder das Terminal

2. Führen Sie den git clone Befehl aus, um das Git-Repository zu klonen.

   code language-bash
   git clone [repository-url]

   note note
   NOTE
   Verwenden Sie zum Klonen des Git-Repositorys die von Adobe Cloud Manager bereitgestellten Anmeldeinformationen.

   Um beispielsweise Ihr Git-Repository zu klonen, führen Sie den folgenden Befehl aus:

   code language-bash
   https://git.cloudmanager.adobe.com/formsinternal01/AEMFormsInternal-ReleaseSanity-p43162-uk59167/

   

Bei Adobe Cloud Manager anmelden

1. Navigieren Sie zu my.cloudmanager.adobe.com
2. Mit Adobe ID anmelden

Navigieren Sie zur Programmübersicht
Wählen Sie Ihr Programm aus der Liste aus. Sie werden zur Seite Programmübersicht weitergeleitet

Zugriff auf und Ansicht der AEM Cloud Service-Umgebung

Sie können die Umgebungsdetails von AEM Cloud Service mit einer der beiden Optionen anzeigen oder darauf zugreifen:

• Option 1: Von der Übersichtsseite

  1. Auf der Seite Programmübersicht

  2. Klicken Sie Menü links„Umgebungen“. Es wird eine Liste aller Umgebungen angezeigt

     

  3. Klicken Sie auf den spezifischen Umgebungsnamen, um die Details anzuzeigen

     

• Option 2: aus dem Abschnitt Umgebungen

  1. Auf der Seite Programmübersicht :

  2. Suchen Sie den Abschnitt Umgebungen.

  3. Klicken Sie auf „Alle anzeigen, um alle Umgebungen anzuzeigen

  4. Klicken Sie auf Menü mit den Auslassungspunkten (…) neben der Umgebung
     

  5. Wählen Sie Details anzeigen“

     

Finden Sie Ihren AEM Forms-Endpunkt

Beachten Sie auf Detailseite Umgebung“ die folgenden Details:

Autoren-Service-URL

• URL: https://author-pXXXXX-eYYYYY.adobeaemcloud.com
• Bucket: author-pXXXXX-eYYYY
  Beispiel: https://author-p43162-e177398.adobeaemcloud.com

Veröffentlichungs-Service-URL

• URL: https://publish-pXXXXX-eYYYYY.adobeaemcloud.com
• Bucket: publish-pXXXXX-eYYYY
  Beispiel: https://publish-author-p43162-e177398.adobeaemcloud.com

Zugriff auf Adobe Developer Console

1. Navigieren Sie zu Adobe Developer Console
2. Mit Adobe ID anmelden

Neues Projekt erstellen

1. Klicken Sie Abschnitt „Schnellstart auf Neues Projekt erstellen

2. Ein neues Projekt wird mit einem Standardnamen erstellt

   

3. Klicken oben auf „Projekt bearbeiten“

   

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

5. Klicken Sie auf Speichern.

   

Klicken Sie auf API hinzufügen

Forms-Kommunikations-APIs

1. Filtern im Dialogfeld „API" nach Experience Cloud
2. Wählen Sie Forms-Kommunikations-APIs“

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

Klicken Sie auf API hinzufügen

• Klicken Sie in Ihrem Projekt auf die Schaltfläche API hinzufügen

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

• Filtern im Dialogfeld „API" nach Experience Cloud
• Wählen Sie AEM Forms-Bereitstellungs- und Laufzeit-API“
• Klicken Sie auf Weiter.

Authentifizierungsmethode

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

Wählen Sie das entsprechende Produktprofil basierend auf der erforderlichen Zugriffsebene aus:

Wählen Sie das Produktprofil aus, das Ihrer Autoren-Service-URL (https://author-pXXXXX-eYYYYY.adobeaemcloud.com) entspricht. Beispiel: https://author-pXXXXX-eYYYYY.adobeaemcloud.com auswählen.

Klicken Sie auf Konfigurierte API speichern. Die API und das Produktprofil werden zu Ihrem Projekt hinzugefügt

Zugriff auf Ihre Anmeldedaten

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

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

Navigieren Sie zu Ihrem Projekt

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

Zugriffs-Token generieren

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

Konfigurationsordner suchen oder erstellen

1. Navigieren Sie zum geklonten AEM Project-Repository und dann zum Ordner config .
2. Wenn es nicht vorhanden ist, erstellen Sie es auf der Stammprojektebene:

mkdir config

Erstellen Sie eine neue Datei mit dem Namen api.yaml im config:

touch config/api.yaml

Fügen Sie den folgenden Code in die api.yaml-Datei ein:

kind: "API"
version: "1"
metadata:
envTypes: ["dev"]  # or ["prod", "stage"] for production environments
data:
allowedClientIDs:
    author:
    - "<your_client_id>"
    publish:
    - "<your_client_id>"
    preview:
    - "<your_client_id>"

Im Folgenden werden die Konfigurationsparameter erläutert:

• kind: Immer auf "API" gesetzt (gibt dies als API-Konfiguration an)

• version: API-Version, normalerweise "1" oder "1.0"

• envTypes: Array von Umgebungstypen, für die diese Konfiguration gilt

  • ["dev"] - Nur Entwicklungsumgebungen
  • ["stage"] - Nur Staging-Umgebungen
  • ["prod"] - Nur Produktionsumgebungen

• allowedClientIDs: Client-IDs dürfen auf Ihre AEM-Instanz zugreifen

  • author: Client-IDs für die Autorenebene
  • publish: Client-IDs für die Veröffentlichungsebene
  • preview: Client-IDs für die Vorschauebene

Fügen Sie beispielsweise die allowedClientIDs als 6bc4589785e246eda29a545d3ca55980 und envTypes als dev hinzu:

Änderungen übernehmen und per Push übertragen

1. Navigieren Sie zum Stammordner des geklonten Repositorys und führen Sie die folgenden Befehle aus:

    git add config/api.yaml
    git commit -m "Whitelist client id for api invocation"
    git push origin <your-branch>

Konfigurations-Pipeline einrichten

1. Bei Cloud Manager anmelden

   1. Navigieren Sie zu my.cloudmanager.adobe.com
   2. Mit Adobe ID anmelden

2. Navigieren Sie zu Ihrem Programm
   Wählen Sie das gewünschte Programm aus der Liste aus, und Sie werden auf die Seite Programmübersicht weitergeleitet

3. Suchen Sie die Karte Pipelines

   1. Suchen Sie die Karte Pipelines auf der Seite Programmübersicht .
   2. Klicken Sie auf Schaltfläche „Hinzufügen

4. Pipeline-Typ auswählen

   • Für Entwicklungsumgebungen: Wählen Sie Produktionsfremde Pipeline hinzufügen“. Produktionsfremde Pipelines sind für Entwicklungs- und Staging-Umgebungen vorgesehen

   • Für Produktionsumgebungen: Wählen Sie Produktions-Pipeline hinzufügen“. Produktions-Pipelines erfordern zusätzliche Genehmigungen

     note note
     NOTE
     Erstellen Sie in diesem Fall eine produktionsfremde Pipeline, da eine Entwicklungsumgebung verfügbar ist.

5. Pipeline konfigurieren - Registerkarte „Konfiguration“

   Auf der Registerkarte Konfiguration:

   a. Pipeline-

   • Wählen Sie Bereitstellungs-Pipeline“

   b. Name der Pipeline

   • Geben Sie einen beschreibenden Namen an, z. B. benennen Sie die Pipeline wie api-config-pipieline

   c. Bereitstellungs-Trigger

   • Manuell: Bereitstellung nur bei manueller Auslösung (für die Ersteinrichtung empfohlen)
   • Bei Git-: Automatische Bereitstellung, wenn Änderungen an die Verzweigung gepusht werden

   d. Verhalten bei bedeutenden Metrikfehlern

   • Jedes Mal fragen: Bei Fehlern Aktion anfordern (Standard)
   • Sofort fehlschlagen: Pipeline bei Metrikfehlern automatisch fehlschlagen
   • Sofort fortfahren: Trotz Fehlern fortfahren

   e. Klicken Sie auf „Weiter“, um zur Registerkarte Source-Code zu gelangen

   

6. Pipeline konfigurieren - Registerkarte "Source-Code“

   Auf der Registerkarte Source Code:

   a. Bereitstellungstyp

   • Wählen Sie Zielgerichtete Bereitstellung“

   b. Bereitstellungsoptionen

   • Wählen Sie „Konfiguration“ (nur Konfigurationsdateien bereitstellen). Dadurch wird Cloud Manager mitgeteilt, dass es sich um eine Konfigurationsbereitstellung handelt.

   c. Geeignete Bereitstellungsumgebung auswählen

   • Wählen Sie die Umgebung aus, in der Sie die Konfiguration bereitstellen möchten. In diesem Fall handelt es sich um eine dev Umgebung.

   d. Definieren von Source-Code-Details

   • Repository: Wählen Sie das Repository aus, das Ihre api.yaml enthält. Wählen Sie beispielsweise das AEMFormsInternal-ReleaseSanity-p43162-uk59167 Repository aus.
   • Git-Verzweigung: Wählen Sie Ihre Verzweigung aus. In diesem Fall wird unser Code beispielsweise in der main bereitgestellt.
   • Code-Speicherort: Geben Sie den Pfad zu config Verzeichnis ein. Da sich api.yaml im Stammordner config befindet, geben Sie /config ein

   e. Klicken Sie auf „Speichern, um die Pipeline zu erstellen

   

Konfiguration bereitstellen

Nachdem die Pipeline erstellt wurde, stellen Sie Ihre api.yaml-Konfiguration bereit:

1. Aus der Pipeline-Übersicht

   1. Suchen Sie auf der Seite Programmübersicht die Karte Pipelines
   2. Navigieren Sie zur neu erstellten Konfigurations-Pipeline in der Liste. Suchen Sie beispielsweise nach dem von Ihnen erstellten Pipeline-Namen (z. B. „api-config-pipeline„). Sie können Pipeline-Details einschließlich Status und letzter Ausführung sehen.

2. Bereitstellung starten

   1. Klicken Sie auf die „Erstellen-Schaltfläche (oder das Wiedergabesymbol ▶) neben Ihrer Pipeline
   2. Bestätigen Sie die Bereitstellung, wenn Sie dazu aufgefordert werden und die Pipeline-Ausführung beginnt

   

3. Überprüfen der erfolgreichen Bereitstellung

   • Warten Sie, bis die Pipeline abgeschlossen ist.

     • Wenn dies erfolgreich ist, ändert sich der Status in „Erfolg“ (grünes Häkchen ✓).

     • Wenn dies fehlschlägt, ändert sich der Status in „Fehlgeschlagen“ (rotes Kreuz ✗). Klicken Sie Protokolle herunterladen, um die Fehlerdetails anzuzeigen.

       

   Jetzt können Sie mit dem Testen der Forms Communications-APIs beginnen. Zu Testzwecken können Sie die Postman, curl oder einen anderen REST-Client verwenden, um die APIs aufzurufen.

Navigieren Sie zur API-Dokumentation

• Forms-API: Forms-API-Referenz
• Document Services: Document Services-API-Referenz
  Öffnen Sie die Document Services-APIs in Ihrem Browser.

Erweitern Sie den Abschnitt Dokumenterstellung und wählen Sie Generiert ein ausfüllbares PDF-Formular aus einer XDP- oder PDF-Vorlage, optional mit Datenzusammenführung.

Klicken Sie im rechten Bereich auf "ausprobieren.

Geben Sie die folgenden Werte ein:

Klicken Sie auf Senden, um die API aufzurufen

Überprüfen Sie die Antwort auf der Registerkarte Antwort:

• Wenn der Antwort-Code 200 ist, bedeutet dies, dass die PDF erfolgreich erstellt wurde.
• Wenn der Antwort-Code 400 ist, bedeutet dies, dass die Anfrageparameter ungültig oder fehlerhaft sind.
• Wenn der Antwort-Code 500 ist, bedeutet dies, dass ein interner Server-Fehler vorliegt.

In diesem Fall lautet der Antwort-Code 200. Das bedeutet, dass die PDF erfolgreich generiert wurde:

Jetzt können Sie die erstellte PDF über die Schaltfläche Herunterladen herunterladen und in PDF Viewer anzeigen:

Öffnen Sie den Befehl cmd/Terminal und führen Sie den Befehl aus:

code .

Das Projekt wird im Code-Editor geöffnet.

Aktualisieren Sie die package.json Datei , um die type zu module hinzuzufügen.

{
"name": "demo-nodejs-generate-pdf",
"version": "1.0.0",
"type": "module",
"main": "index.js",
}

Erstellen der .env-Datei auf der Stammebene eines Projekts

Fügen Sie die folgende Konfiguration hinzu und ersetzen Sie die Platzhalter durch die tatsächlichen Werte aus den OAuth Server-zu-Server-Anmeldeinformationen des ADC-Projekts.

CLIENT_ID=<ADC Project OAuth Server-to-Server credential ClientID>
CLIENT_SECRET=<ADC Project OAuth Server-to-Server credential Client Secret>
SCOPES=<ADC Project OAuth Server-to-Server credential Scopes>