Verwenden der synchronen Verarbeitung sync-processing-introduction
Forms as a Cloud Service – Mit den Kommunikations-APIs können Sie markenorientierte und personalisierte Texte erstellen, zusammenstellen und bereitstellen, wie z. B. Geschäftskorrespondenz, Dokumente, Kontoauszüge, Briefe zur Bearbeitung von Ansprüchen, Leistungsbescheide, monatliche Rechnungen oder Begrüßungspakete. Sie können Communications APIs verwenden, um eine Vorlage (XFA oder PDF) mit Kundendaten zu kombinieren und damit Dokumente im PDF-, PS-, PCL-, DPL-, IPL- und ZPL-Format zu generieren.
Angenommen, Sie haben eine oder mehrere Vorlagen und für jede Vorlage mehrere Datensätze mit XML-Daten. Sie können Kommunikations-APIs verwenden, um für jeden Eintrag ein Print-Dokument zu generieren. Das Ergebnis ist ein nicht interaktives PDF-Dokument. Bei einem nicht interaktiven PDF-Dokument können Benutzer keine Daten in die Felder eingeben.
Forms as a Cloud Service Communications bietet On-Demand- und Batch-APIs (asynchrone APIs) für die geplante Dokumenterstellung:
-
Synchrone APIs eignen sich für die Dokumenterstellung auf Anfrage, mit geringer Latenz und mit einzelnen Datensätzen. Diese APIs eignen sich besser für Anwendungen auf Basis einer Benutzeraktion. Zum Beispiel zum Generieren eines Dokuments, nachdem ein Anwender ein Formular ausgefüllt hat.
-
Batch-APIs (asynchrone APIs) eignen sich für Anwendungsfälle für die geplante Erstellung mehrerer Dokumente mit hohem Durchsatz. Diese APIs generieren Dokumente in Stapeln. Beispielsweise werden damit monatliche Telefonrechnungen, Kreditkartenauszüge und Leistungsmitteilungen generiert.
Verwenden von synchronen Vorgängen batch-operations
Ein synchroner Vorgang ist ein Prozess, bei dem Dokumente linear generiert werden. Diese APIs werden als Einzelmandant-APIs und Multi-Mandant-APIs klassifiziert:
Einzelmandant-APIs
- APIs zur Dokumenterstellung
- APIs zur Dokumentbearbeitung
Authentifizierung einer Einzelmandant-API
Einzelmandant-API-Vorgänge unterstützen zwei Authentifizierungstypen:
-
Einfache Authentifizierung: Die einfache Authentifizierung ist ein einfaches Authentifizierungsschema, das in das HTTP-Protokoll integriert ist. Der Client sendet HTTP-Anfragen mit dem Autorisierungs-Header, der das Wort „Basic“, gefolgt von einem Leerzeichen und einer base64-kodierten Zeichenfolge „username:password“ enthält. Um beispielsweise als admin / admin zu autorisieren, sendet der Client Basic [base64-kodierte Zeichenfolge Benutzername]: [base64-kodierte Zeichenfolge Kennwort].
-
Token-basierte Authentifizierung: Die Token-basierte Authentifizierung verwendet ein Zugriffstoken (Bearer-Authentifizierungstoken), um Anfragen an Experience Manager as a Cloud Service zu senden. AEM Forms as a Cloud Service stellt APIs zum sicheren Abrufen des Zugriffstokens bereit. So rufen Sie das Token ab und verwenden es, um eine Anfrage zu authentifizieren:
- Rufen Sie die Anmeldedaten für Experience Manager as a Cloud Service über die Entwicklerkonsole ab.
- Installieren Sie die Anmeldedaten für Experience Manager as a Cloud Service in Ihrer Umgebung. (Programm-Server, Webserver oder andere Nicht-AEM-Server), die zum Senden von Anfragen an den Cloud-Service (Aufrufe) konfiguriert sind.
- Erstellen Sie ein JWT-Token und tauschten Sie es mithilfe von Adobe IMS-APIs gegen ein Zugriffstoken aus.
- Führen Sie die Experience Manager-API mit dem Zugriffstoken als Bearer-Authentifizierungstoken aus.
- Legen Sie die entsprechenden Berechtigungen für den Benutzer des technischen Kontos in der Experience Manager-Umgebung fest.
note note NOTE Adobe empfiehlt die Verwendung der Token-basierten Authentifizierung in einer Produktionsumgebung.
(Nur für APIs zur Dokumenterzeugung) Konfigurieren von Assets und Berechtigungen
Um synchrone APIs zu verwenden, ist Folgendes erforderlich:
- Benutzende mit Experience Manager-Administratorberechtigungen
- Hochladen von Vorlagen und anderen Assets in Ihre Experience Manager Forms Cloud Service-Instanz
(Nur für APIs zur Dokumenterzeugung) Hochladen von Vorlagen und anderen Assets in Ihre Experience Manager-Instanz
Eine Organisation verfügt in der Regel über mehrere Vorlagen. Zum Beispiel eine Vorlage für Kreditkartenauszüge, Leistungsmitteilungen und Anträge. Laden Sie alle diese XDP- und PDF-Vorlagen in Ihre Experience Manager-Instanz hoch. Hochladen von Vorlagen:
- Öffnen Sie die Experience Manager-Instanz.
- Navigieren Sie zu „Forms“ > „Forms und Dokumente“.
- Klicken Sie auf „Erstellen“ > „Ordner“ und erstellen Sie einen Ordner. Öffnen Sie den Ordner.
- Klicken Sie auf „Erstellen“ > „Datei-Upload“ und laden Sie die Vorlagen hoch.
Aufrufen einer API
Die Dokumentation zur API-Referenz enthält detaillierte Informationen zu allen Parametern, Authentifizierungsmethoden und verschiedenen Services, die von APIs bereitgestellt werden. Die API-Referenzdokumentation enthält auch eine API-Definitionsdatei im .yaml-Format. Sie können die .yaml-Datei herunterladen und in Postman hochladen, um die Funktionalität der APIs zu überprüfen.