AEM Forms Communications APIs - Übersicht

AEM Forms-APIs bieten eine umfassende Suite an Cloud-nativen APIs, die Unternehmen bei der Automatisierung von Dokumenten-Workflows unterstützen.

AEM Forms-APIs sind über zwei Hauptkonsolen strukturiert und zugänglich:

  • Adobe Developer Console (ADC) - Adobe Developer Console ist das Gateway zu Adobe-APIs, Ereignissen, Runtime und App Builder.

  • AEM Developer Console - AEM Developer Console bietet Zugriff auf Details auf Umgebungsebene, Konfigurationen, technische Konten und Service-Anmeldeinformationen, um Betriebs- und Integrationsaufgaben zu unterstützen.

Verschiedene APIs unterstützen verschiedene Authentifizierungsmethoden.

Authentifizierungsmethoden

Verschiedene Forms-APIs verwenden je nach Veröffentlichungszeitplan unterschiedliche Authentifizierungsmethoden:

Frühere APIs unterstützen die JWT-basierte Server-zu-Server-Authentifizierung, die über die AEM Developer Console konfiguriert und verwaltet wird. Neuere APIs verwenden OAuth-Server-zu-Server-Authentifizierung und werden über die Adobe Developer Console konfiguriert.

Übersicht über die API-Klassifizierung

Alle AEM Forms-APIs sind in zwei Hauptteile unterteilt:

Details
APIs für Bereitstellung und Laufzeit adaptiver Formulare
Kommunikations-APIs
Zweck
Verarbeiten von Bereitstellungs- und Laufzeitvorgängen für adaptive Formulare
Dokumenterstellung und -bearbeitung
Anwendungsszenarien
- Formular-Rendering
-
- Formularübermittlungen
- Entwurfsverwaltung
- PDF-
: Zusammenführen von Dokumenten
Stapelverarbeitung
Druckvorgänge
Autorisierungsmethode
Unterstützt OAuth-Server-zu-Server-/Benutzer-Authentifizierungsmethoden.
Unterstützt je nach API die Server-zu-Server-Authentifizierung, entweder JWT oder OAuth. Eine API kann nicht beide Authentifizierungsmethoden unterstützen.

AEM Forms Communications-APIs

Kommunikations-APIs sind der primäre Fokus für dokumentzentrierte Vorgänge.

In der folgenden Tabelle sind alle AEM Forms Communications APIs ​ ihre unterstützten Authentifizierungsmethoden und Ausführungsmodelle aufgeführt:

APIs zur Dokumenterstellung

API-Endpunkt
Beschreibung
Ausführungsmodell
Authentifizierungsmethode
/adobe/forms/batch/output/config
Erstellt eine neue Batch-Konfiguration für Dokumenterstellungsaufträge.
Asynchron/Batch
JWT
/adobe/forms/batch/output/config/{configName}
Ruft Details zu einer bestimmten Batch-Konfiguration ab.
Asynchron/Batch
JWT
/adobe/forms/batch/output/config/configs
Gibt eine Liste aller verfügbaren Batch-Konfigurationen zurück.
Asynchron/Batch
JWT
/adobe/forms/batch/output/config/{configName}/execution
Startet eine Batch-Ausgabegenerierung mithilfe einer Konfiguration.
Asynchron/Batch
JWT
/adobe/forms/batch/output/config/{configName}/execution/{executionId}
Ruft den Ausführungsstatus eines Batch-Vorgangs ab.
Asynchron/Batch
JWT
/adobe/forms/batch/output/config/{configName}/execution
Listet alle laufenden Instanzen für eine bestimmte Batch-Konfiguration auf.
Asynchron/Batch
JWT
/adobe/forms/doc/v1/generatePDFOutput
Erzeugt synchron eine PDF-Ausgabe basierend auf Vorlagen und Daten.
Synchron
JWT
/adobe/forms/doc/v1/generatePrintedOutput
Generiert druckfertige Ausgabeformate (z. B. PCL, PostScript).
Synchron
JWT
/adobe/forms/doc/v1/generate/afp
Generiert eine AFP-Ausgabe für den Druck großer Volumen.
Synchron
JWT
/adobe/document/generate/pdfform
Rendert ein PDF-Formular (XFA/XDP) mit zusammengeführten Daten.
Synchron
OAuth
/adobe/document/generate/pdfform/jobs/{id}/status
Ruft den Status eines PDF-Formulargenerierungsauftrags ab.
Synchron
OAuth
/adobe/document/generate/pdfform/jobs/{id}/result
Ruft die Ausgabe/das Ergebnis eines abgeschlossenen PDF-Formularauftrags ab.
Synchron
OAuth

APIs zur Dokumentbearbeitung

API-Endpunkt
Beschreibung
Ausführungsmodell
Authentifizierungsmethode
/adobe/forms/assembler/ddx/invoke
Führt DDX-Anweisungen aus, um PDFs zu kombinieren, aufzuteilen oder zu bearbeiten.
Synchron
JWT
/adobe/forms/assembler/pdfa/convert
Konvertiert ein PDF-Dokument in das PDF/A-Format.
Synchron
JWT
/adobe/forms/assembler/pdfa/validate
Prüft, ob ein PDF den PDF/A-Standard erfüllt
Synchron
JWT

APIs zur Dokumentkonvertierung

API-Endpunkt
Beschreibung
Ausführungsmodell
Authentifizierungsmethode
/adobe/document/convert/pdftoxdp
Konvertiert ein PDF-Formular in das XDP-Format.
Synchron
OAuth

APIs zur Dokumentextraktion

API-Endpunkt
Beschreibung
Ausführungsmodell
Authentifizierungsmethode
/adobe/forms/doc/v1/extract/pdfproperties
Extrahiert Eigenschaften und Strukturinformationen aus einer PDF.
Synchron
OAuth
/adobe/forms/doc/v1/extract/usagerrights
Extrahiert in eine PDF eingebettete Verwendungsrechte.
Synchron
OAuth
/adobe/forms/doc/v1/extract/metadata
Extrahiert Metadaten wie Titel, Autor und Schlüsselwörter.
Synchron
OAuth
/adobe/forms/doc/v1/extract/data
Extrahiert Formulardaten (XML/JSON) aus PDF forms.
Synchron
OAuth
/adobe/document/extract/security
Extrahiert Sicherheitseinstellungen wie Berechtigungen und Verschlüsselung.
Synchron
OAuth

Document Transformation-APIs

API-Endpunkt
Beschreibung
Ausführungsmodell
Authentifizierungsmethode
/adobe/document/transform/metadata
Aktualisiert oder fügt Metadaten in einem PDF-Dokument hinzu.
Synchron
OAuth
/adobe/document/field/signature/add
Fügt ein digitales Signaturfeld zu einer PDF hinzu.
Synchron
OAuth
/adobe/document/field/signature/clear
Löscht den Inhalt eines Signaturfelds.
Synchron
OAuth
/adobe/document/field/signature/remove
Entfernt ein Signaturfeld aus einer PDF.
Synchron
OAuth

Document Assurance-APIs

API-Endpunkt
Beschreibung
Ausführungsmodell
Authentifizierungsmethode
/adobe/document/assurance/usagerrights
Wendet Verwendungsrechte auf eine PDF an (z. B. Kommentieren, Ausfüllen, Signieren).
Synchron
OAuth
/adobe/document/assurance/encrypt
Verschlüsselt eine PDF mit Passwort- oder Zertifikatsicherheit.
Synchron
OAuth
/adobe/document/assurance/decrypt
Entschlüsselt ein gesichertes PDF-Dokument.
Synchron
OAuth
/adobe/document/assurance/sign
Digitales Signieren eines PDF-Dokuments.
Synchron
OAuth
/adobe/document/assurance/certificate
Zertifiziert eine PDF mit einem digitalen Zertifikat.
Synchron
OAuth

Verwandte Schritte

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