Panoramica delle API di comunicazione di AEM Forms

Le API di AEM Forms forniscono una suite completa di API native per il cloud progettate per aiutare le aziende ad automatizzare i flussi di lavoro dei documenti.

Le API di AEM Forms sono strutturate e accessibili tramite due console primarie:

  • Adobe Developer Console (ADC) - Adobe Developer Console è il gateway per API, eventi, runtime e App Builder di Adobe.

  • AEM Developer Console - AEM Developer Console fornisce accesso a dettagli a livello di ambiente, configurazioni, account tecnici e credenziali di servizio per supportare attività operative e di integrazione.

Diverse API supportano metodi di autenticazione diversi.

Metodi di autenticazione

Diverse API di Forms utilizzano metodi di autenticazione diversi in base alla timeline della loro versione:

Le API precedenti supportano l’autenticazione da server a server basata su JWT, configurata e gestita tramite AEM Developer Console. Le API più recenti utilizzano l’autenticazione server-to-server di OAuth e sono configurate tramite Adobe Developer Console.

Panoramica sulla classificazione API

Tutte le API di AEM Forms sono suddivise in due parti principali:

Dettagli
Consegna di moduli adattivi e API runtime
API di comunicazione
Scopo
Gestire le operazioni di consegna e runtime dei moduli adattivi
Generazione e manipolazione di documenti
Casi d’uso
- Rendering modulo
- Precompilazione dati
- Invii modulo
- Gestione bozze
- Generazione PDF
- Unione documenti
- Elaborazione batch
- Operazioni di stampa
Metodo di autorizzazione
Supporta i metodi di autenticazione server-to-server/utente di OAuth.
Supporta l’autenticazione da server a server, JWT o OAuth a seconda dell’API. Un’API non può supportare entrambi i metodi di autenticazione.

API di comunicazione di AEM Forms

Le API di comunicazione sono l’obiettivo principale per le operazioni incentrate sui documenti.

La tabella seguente elenca tutte le API di AEM Forms Communications insieme ai relativi metodi di autenticazione e modelli di esecuzione supportati:

API per la generazione di documenti

Endpoint API
Descrizione
Modello di esecuzione
Metodo di autenticazione
/adobe/forms/batch/output/config
Crea una nuova configurazione batch per i processi di generazione dei documenti.
Asincrono/Batch
JWT
/adobe/forms/batch/output/config/{configName}
Recupera i dettagli di una configurazione batch specifica.
Asincrono/Batch
JWT
/adobe/forms/batch/output/config/configs
Restituisce un elenco di tutte le configurazioni batch disponibili.
Asincrono/Batch
JWT
/adobe/forms/batch/output/config/{configName}/execution
Avvia l'esecuzione di una generazione di output batch utilizzando una configurazione.
Asincrono/Batch
JWT
/adobe/forms/batch/output/config/{configName}/execution/{executionId}
Recupera lo stato di esecuzione di un processo batch.
Asincrono/Batch
JWT
/adobe/forms/batch/output/config/{configName}/execution
Elenca tutte le istanze in esecuzione per una configurazione batch specifica.
Asincrono/Batch
JWT
/adobe/forms/doc/v1/generatePDFOutput
Genera l’output di PDF in modo sincrono in base a modelli e dati.
Sincrono
JWT
/adobe/forms/doc/v1/generatePrintedOutput
Genera formati di output pronti per la stampa (ad esempio, PCL, PostScript).
Sincrono
JWT
/adobe/forms/doc/v1/generate/afp
Genera output AFP per la stampa di volumi elevati.
Sincrono
JWT
/adobe/document/generate/pdfform
Esegue il rendering di un PDF Form (XFA/XDP) con dati uniti.
Sincrono
OAuth
/adobe/document/generate/pdfform/jobs/{id}/status
Recupera lo stato di un processo di generazione di moduli di PDF.
Sincrono
OAuth
/adobe/document/generate/pdfform/jobs/{id}/result
Recupera l’output/risultato di un processo modulo di PDF completato.
Sincrono
OAuth

API per la manipolazione dei documenti

Endpoint API
Descrizione
Modello di esecuzione
Metodo di autenticazione
/adobe/forms/assembler/ddx/invoke
Esegue le istruzioni DDX per combinare, dividere o manipolare i PDF.
Sincrono
JWT
/adobe/forms/assembler/pdfa/convert
Converte un documento PDF in formato PDF/A.
Sincrono
JWT
/adobe/forms/assembler/pdfa/validate
Convalida se un PDF è conforme allo standard PDF/A
Sincrono
JWT

API di conversione dei documenti

Endpoint API
Descrizione
Modello di esecuzione
Metodo di autenticazione
/adobe/document/convert/pdftoxdp
Converte un modulo PDF in formato XDP.
Sincrono
OAuth

API di estrazione documenti

Endpoint API
Descrizione
Modello di esecuzione
Metodo di autenticazione
/adobe/forms/doc/v1/extract/pdfproperties
Estrae proprietà e informazioni strutturali da un PDF.
Sincrono
OAuth
/adobe/forms/doc/v1/extract/usagerights
Estrae i diritti di utilizzo incorporati in un PDF.
Sincrono
OAuth
/adobe/forms/doc/v1/extract/metadata
Estrae metadati come titolo, autore e parole chiave.
Sincrono
OAuth
/adobe/forms/doc/v1/extract/data
Estrae dati modulo (XML/JSON) da PDF forms.
Sincrono
OAuth
/adobe/document/extract/security
Estrae le impostazioni di protezione, ad esempio autorizzazioni e crittografia.
Sincrono
OAuth

API di trasformazione dei documenti

Endpoint API
Descrizione
Modello di esecuzione
Metodo di autenticazione
/adobe/document/transform/metadata
Aggiorna o aggiunge metadati in un documento PDF.
Sincrono
OAuth
/adobe/document/field/signature/add
Aggiunge un campo di firma digitale a un PDF.
Sincrono
OAuth
/adobe/document/field/signature/clear
Cancella il contenuto di un campo firma.
Sincrono
OAuth
/adobe/document/field/signature/remove
Rimuove un campo firma da un PDF.
Sincrono
OAuth

Documentare le API di Assurance

Endpoint API
Descrizione
Modello di esecuzione
Metodo di autenticazione
/adobe/document/sure/usagerights
Applica i diritti di utilizzo a un PDF (ad esempio, commento, riempimento, segno).
Sincrono
OAuth
/adobe/document/sure/encrypt
Crittografa un PDF con protezione tramite password o certificato.
Sincrono
OAuth
/adobe/document/sure/decrypt
Decritta un documento PDF protetto.
Sincrono
OAuth
/adobe/document/sure/sign
Firma digitalmente un documento PDF.
Sincrono
OAuth
/adobe/document/sure/certify
Certifica un PDF con un certificato digitale.
Sincrono
OAuth

Passaggi correlati

Scopri come impostare l’ambiente per le API di comunicazione Forms sincrone (su richiesta) e asincrone (in batch):

API sincrone

API di comunicazione AEM Forms - Sincrono

Scopri come impostare l’ambiente per le API di comunicazione Forms sincrone (on-demand) che generano o elaborano documenti all’istante.

Ulteriori informazioni

API asincrone

API di comunicazione AEM Forms - Asincrono (batch)

Scopri come impostare l’ambiente per le API di comunicazione Forms asincrone (in batch) che generano o elaborano più documenti in modo pianificato.

Ulteriori informazioni

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