AEM Forms Communications API's - Overzicht

AEM Forms API's bieden een uitgebreid pakket van in de cloud geïntegreerde API's die zijn ontworpen om bedrijven te helpen bij het automatiseren van documentworkflows.

AEM Forms API's zijn gestructureerd en toegankelijk via twee primaire consoles:

  • ​ Adobe Developer Console (ADC) ​ - Adobe Developer Console is de gateway aan Adobe APIs, Gebeurtenissen, Runtime en App Builder.

  • ​ AEM Developer Console ​ - AEM Developer Console verleent toegang tot milieu-vlakke details, configuraties, technische rekeningen, en de dienstgeloofsbrieven om operationele en integratietaken te steunen.

Verschillende APIs steunt verschillende ​ authentificatiemethodes ​.

Verificatiemethoden

Verschillende Forms API's gebruiken verschillende verificatiemethoden op basis van hun releasetijdlijn:

Eerdere API's ondersteunen JWT-gebaseerde server-to-server verificatie, die wordt geconfigureerd en beheerd via de AEM Developer Console. Nieuwere API's maken gebruik van OAuth Server-to-Server-verificatie en worden geconfigureerd via de Adobe Developer Console.

API-classificatieoverzicht

Alle AEM Forms API's zijn verdeeld in twee hoofdonderdelen:

Details
API's voor adaptieve levering en uitvoering van formulieren
Communicatie-API's
Doel
Aangepaste levering van formulieren en runtimebewerkingen verwerken
Documentgeneratie en -manipulatie
Gevallen gebruiken
- Formulierweergave
- Vooraf ingevulde gegevens
- Formulierverzendingen
- Conceptbeheer
- PDF genereren
- Document samenvoegen
- Batchverwerking
- Afdrukbewerkingen
Autorisatiemethode
Ondersteunt de verificatiemethoden van beide servers.
Ondersteunt server-naar-serververificatie, JWT of OAuth, afhankelijk van de API. Een API kan beide verificatiemethoden niet ondersteunen.

AEM Forms Communications API's

Communicatie-API's vormen de belangrijkste focus voor documentgerichte bewerkingen.

De lijst hieronder maakt een lijst van alle ​ Communicatie APIs van AEM Forms ​ samen met hun gesteunde authentificatiemethodes en uitvoeringsmodellen:

API's voor het genereren van documenten

API-eindpunt
Beschrijving
Uitvoeringsmodel
Verificatiemethode
​ /adobe/forms/batch/output/config ​
Hiermee maakt u een nieuwe batchconfiguratie voor taken voor het genereren van documenten.
Asynchroon/Batch
​ JWT ​
​ /adobe/forms/batch/output/config/{configName} ​
Haalt details van een specifieke partijconfiguratie op.
Asynchroon/Batch
​ JWT ​
​ /adobe/forms/batch/output/config/configs ​
Retourneert een lijst met alle beschikbare batchconfiguraties.
Asynchroon/Batch
​ JWT ​
​ /adobe/forms/batch/output/config/{configName}/executing
Begint een runtime van de partijoutputgeneratie gebruikend een configuratie.
Asynchroon/Batch
​ JWT ​
​ /adobe/forms/batch/output/config/{configName} /executing/{executionId} ​
Hiermee wordt de uitvoeringsstatus van een batchtaak opgehaald.
Asynchroon/Batch
​ JWT ​
​ /adobe/forms/batch/output/config/{configName} /Executions
Vermeldt alle lopende instanties voor een specifieke partijconfiguratie.
Asynchroon/Batch
​ JWT ​
​ /adobe/forms/doc/v1/generatePDFOutput ​
Hiermee genereert u synchroon PDF-uitvoer op basis van sjablonen en gegevens.
Synchroon
​ JWT ​
​ /adobe/forms/doc/v1/generatePrintedOutput ​
Hiermee genereert u uitvoerindelingen die klaar zijn voor afdrukken (bijvoorbeeld PCL, PostScript).
Synchroon
​ JWT ​
​ /adobe/forms/doc/v1/generate/afp ​
Hiermee genereert u AFP-uitvoer voor afdrukken op grote volumes.
Synchroon
​ JWT ​
​ /adobe/document/generate/pdfform ​
Hiermee maakt u een PDF-formulier (XFA/XDP) met samengevoegde gegevens.
Synchroon
​ OAuth ​
​ /adobe/document/generate/pdfform/jobs/{id} /status
Hiermee wordt de status van een PDF-formuliergeneratietaak opgehaald.
Synchroon
​ OAuth ​
​ /adobe/document/generate/pdfform/jobs/{id} /result ​
Hiermee wordt de uitvoer/het resultaat van een voltooide PDF-formuliertaak opgehaald.
Synchroon
​ OAuth ​

Documentmanipulatie-API's

API-eindpunt
Beschrijving
Uitvoeringsmodel
Verificatiemethode
​ /adobe/forms/assembler/ddx/invoke ​
Hiermee voert u DDX-instructies uit om PDF's te combineren, te splitsen of te bewerken.
Synchroon
​ JWT ​
​ /adobe/forms/assembler/pdfa/convert
Converteert een PDF-document naar de indeling PDF/A.
Synchroon
​ JWT ​
​ /adobe/forms/assembler/pdfa/validate ​
Valideert of een PDF voldoet aan de PDF/A-standaard
Synchroon
​ JWT ​

Documentconversie-API's

API-eindpunt
Beschrijving
Uitvoeringsmodel
Verificatiemethode
​ /adobe/document/convert/pdftoxdp ​
Converteert een PDF-formulier naar XDP-indeling.
Synchroon
​ OAuth ​

Extractie-API's voor documenten

API-eindpunt
Beschrijving
Uitvoeringsmodel
Verificatiemethode
​ /adobe/forms/doc/v1/extract/pdfproperties ​
Hiermee worden eigenschappen en structuurgegevens opgehaald uit een PDF.
Synchroon
​ OAuth ​
​ /adobe/forms/doc/v1/extract/usagerights ​
Extraheert gebruiksrechten die zijn ingesloten in een PDF.
Synchroon
​ OAuth ​
​ /adobe/forms/doc/v1/extract/metadata ​
Extraheert metagegevens zoals titel, auteur en trefwoorden.
Synchroon
​ OAuth ​
​ /adobe/forms/doc/v1/extract/data ​
Extraheert formuliergegevens (XML/JSON) uit PDF forms.
Synchroon
​ OAuth ​
​ /adobe/document/extract/security
Hiermee worden beveiligingsinstellingen opgehaald, zoals machtigingen en versleuteling.
Synchroon
​ OAuth ​

API's voor documenttransformatie

API-eindpunt
Beschrijving
Uitvoeringsmodel
Verificatiemethode
​ /adobe/document/transform/metadata ​
Hiermee werkt u metagegevens bij in een PDF-document of voegt u deze toe.
Synchroon
​ OAuth ​
​ /adobe/document/field/signature/add
Hiermee voegt u een veld voor een digitale handtekening toe aan een PDF.
Synchroon
​ OAuth ​
​ /adobe/document/field/signature/clear ​
Wist de inhoud van een handtekeningveld.
Synchroon
​ OAuth ​
​ /adobe/document/field/signature/remove
Hiermee verwijdert u een handtekeningveld uit een PDF.
Synchroon
​ OAuth ​

Document Assurance API's

API-eindpunt
Beschrijving
Uitvoeringsmodel
Verificatiemethode
​ /adobe/document/sure/usagerights ​
Hiermee past u gebruiksrechten toe op een PDF (bijvoorbeeld opmerking, vulling, teken).
Synchroon
​ OAuth ​
​ /adobe/document/confirm/encrypt ​
Codeert een PDF met wachtwoord- of certificaatbeveiliging.
Synchroon
​ OAuth ​
​ /adobe/document/sure/decrypt ​
Decodeert een beveiligd PDF-document.
Synchroon
​ OAuth ​
​ /adobe/document/confirm/sign
Hiermee wordt een PDF-document digitaal ondertekend.
Synchroon
​ OAuth ​
​ /adobe/document/confirm/certify
Hiermee wordt een PDF gecertificeerd met een digitaal certificaat.
Synchroon
​ OAuth ​

Verwante stappen

Leer hoe u een omgeving instelt voor synchrone (On-Demand) en asynchrone (Batch) Forms Communications API's:

Synchrone API's

Communicatie APIs van AEM Forms - Synchroon

Leer hoe u een omgeving instelt voor synchrone (on-demand) communicatie-API's die direct documenten genereren of verwerken.

Leer meer

Asynchrone API's

Communicatie APIs van AEM Forms - Asynchroon (Partij)

Leer hoe u een omgeving instelt voor Asynchronous (Batch) Forms Communications API's die meerdere documenten op een geplande manier genereren of verwerken.

Leer meer

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