AEM Forms Communications APIs - Översikt

AEM Forms API:er innehåller en omfattande uppsättning molnbaserade API:er som hjälper företag att automatisera dokumentarbetsflöden.

AEM Forms API:er är strukturerade och åtkomliga via två primära konsoler:

  • Adobe Developer Console (ADC) - Adobe Developer Console är gateway till Adobe API:er, händelser, körningsmiljö och App Builder.

  • AEM Developer Console - AEM Developer Console ger åtkomst till information, konfigurationer, tekniska konton och inloggningsuppgifter på miljönivå som stöd för drifts- och integreringsuppgifter.

Olika API:er stöder olika autentiseringsmetoder.

Autentiseringsmetoder

Olika Forms-API:er använder olika autentiseringsmetoder som baseras på tidslinjen för releasen:

Tidigare API:er stöder JWT-baserad server-till-server-autentisering, som konfigureras och hanteras via AEM Developer Console. Nyare API:er använder OAuth Server-till-Server-autentisering och konfigureras via Adobe Developer Console.

API-klassificeringsöversikt

Alla AEM Forms API:er är uppdelade i två huvuddelar:

Information
API:er för leverans och körning av adaptiva formulär
Kommunikations-API:er
Syfte
Hantera leverans av adaptiva formulär och körningsåtgärder
Generering och hantering av dokument
Användningsexempel
- Formuläråtergivning
- Dataförifyllning
- Formuläröverföringar
- Hantering av utkast
- PDF-generering
- Dokumentsammanfogning
- Gruppbearbetning
- Utskriftsåtgärder
Auktoriseringsmetod
Stöder autentiseringsmetoderna OAuth Server-to-Server/User.
Stöder autentisering från server till server, antingen JWT eller OAuth beroende på API:t. Ett API har inte stöd för båda autentiseringsmetoderna.

AEM Forms Communications APIs

Kommunikations-API:er är det primära fokus för dokumentcentrerade åtgärder.

I tabellen nedan visas alla AEM Forms Communications API:er tillsammans med autentiseringsmetoder och körningsmodeller som stöds:

API för dokumentgenerering

API-slutpunkt
Beskrivning
Körningsmodell
Autentiseringsmetod
/adobe/forms/batch/output/config
Skapar en ny batchkonfiguration för dokumentgenereringsjobb.
Asynkron/batch
JWT
/adobe/forms/batch/output/config/{configName}
Hämtar information om en specifik batchkonfiguration.
Asynkron/batch
JWT
/adobe/forms/batch/output/config/configs ​
Returnerar en lista med alla tillgängliga batchkonfigurationer.
Asynkron/batch
JWT
/adobe/forms/batch/output/config/{configName}/execution
Startar en batchutdatagenerering som körs med en konfiguration.
Asynkron/batch
JWT
/adobe/forms/batch/output/config/{configName}/execution/{executionId}
Hämtar körningsstatus för ett batchjobb.
Asynkron/batch
JWT
/adobe/forms/batch/output/config/{configName}/Executions
Visar alla instanser som körs för en specifik batchkonfiguration.
Asynkron/batch
JWT
/adobe/forms/doc/v1/generatePDFOutput
Genererar PDF-utdata synkront baserat på mallar och data.
Synkron
JWT
/adobe/forms/doc/v1/generatePrintedOutput
Genererar utskriftsklara utdataformat (t.ex. PCL, PostScript).
Synkron
JWT
/adobe/forms/doc/v1/generate/afp
Genererar AFP-utdata för stora utskriftsvolymer.
Synkron
JWT
/adobe/document/generate/pdfform ​
Återger ett PDF-formulär (XFA/XDP) med sammanfogade data.
Synkron
OAuth
/adobe/document/generate/pdfform/job/{id}/status ​
Hämtar status för ett PDF-formulärgenereringsjobb.
Synkron
OAuth
/adobe/document/generate/pdfform/job/{id}/result
Hämtar utdata/resultat för ett slutfört PDF-formulärjobb.
Synkron
OAuth

API:er för dokumenthantering

API-slutpunkt
Beskrivning
Körningsmodell
Autentiseringsmetod
/adobe/forms/assembler/ddx/invoke
Kör DDX-instruktioner för att kombinera, dela eller ändra PDF-filer.
Synkron
JWT
/adobe/forms/assembler/pdfa/convert
Konverterar ett PDF-dokument till PDF/A-format.
Synkron
JWT
/adobe/forms/assembler/pdfa/validate
Validerar om en PDF uppfyller PDF/A-standarden
Synkron
JWT

API:er för dokumentkonvertering

API-slutpunkt
Beskrivning
Körningsmodell
Autentiseringsmetod
/adobe/document/convert/pdftoxdp
Konverterar ett PDF-formulär till XDP-format.
Synkron
OAuth

API för dokumentextrahering

API-slutpunkt
Beskrivning
Körningsmodell
Autentiseringsmetod
/adobe/forms/doc/v1/extract/pdfproperties
Extraherar egenskaper och strukturinformation från en PDF.
Synkron
OAuth
/adobe/forms/doc/v1/extract/usagerights
Extraherar användarrättigheter som är inbäddade i en PDF.
Synkron
OAuth
/adobe/forms/doc/v1/extract/metadata ​
Extraherar metadata som titel, författare och nyckelord.
Synkron
OAuth
/adobe/forms/doc/v1/extract/data ​
Hämtar formulärdata (XML/JSON) från PDF forms.
Synkron
OAuth
/adobe/document/extract/security
Extraherar skyddsinställningar som behörigheter och kryptering.
Synkron
OAuth

API:er för dokumentomvandling

API-slutpunkt
Beskrivning
Körningsmodell
Autentiseringsmetod
/adobe/document/transform/metadata
Uppdaterar eller lägger till metadata i ett PDF-dokument.
Synkron
OAuth
/adobe/document/field/signature/add
Lägger till ett fält för elektronisk underskrift i en PDF.
Synkron
OAuth
/adobe/document/field/signature/clear
Rensar innehållet i ett signaturfält.
Synkron
OAuth
/adobe/document/field/signature/remove
Tar bort ett signaturfält från en PDF.
Synkron
OAuth

Dokument-API:er för Assurance

API-slutpunkt
Beskrivning
Körningsmodell
Autentiseringsmetod
/adobe/document/ensure/usagerights
Tillämpar användarrättigheter för en PDF (t.ex. kommentar, fyll i, signera).
Synkron
OAuth
/adobe/document/ensure/encrypt
Krypterar en PDF med lösenord eller certifikatskydd.
Synkron
OAuth
/adobe/document/ensure/decrypt
Dekrypterar ett skyddat PDF-dokument.
Synkron
OAuth
/adobe/document/ensure/sign
Signera ett PDF-dokument digitalt.
Synkron
OAuth
/adobe/document/ensure/certify
Certifierar en PDF med ett digitalt certifikat.
Synkron
OAuth

Relaterade steg

Lär dig hur du ställer in miljön för API:er för synkron (On-Demand) och asynkron (Batch) Forms Communications:

Synkrona API:er

API:er för AEM Forms Communications - Synkron

Lär dig hur du konfigurerar miljö för Synkrona (on-demand) API:er för Forms Communications som genererar eller bearbetar dokument direkt.

Läs mer

Asynkrona API:er

AEM Forms Communications API:er - asynkron (batch)

Lär dig hur du konfigurerar miljö för asynkrona (Batch) Forms Communications API:er som genererar eller bearbetar flera dokument på ett schemalagt sätt.

Läs mer

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