Utilizzare l’elaborazione sincrona

Le comunicazioni consentono di creare, assemblare e distribuire comunicazioni personalizzate e orientate al marchio, ad esempio corrispondenze aziendali, documenti, dichiarazioni, lettere di elaborazione delle richieste, note sui benefit, lettere di elaborazione delle richieste, fatture mensili e kit di benvenuto. È possibile utilizzare le API di comunicazione per combinare un modello (XFA o PDF) con i dati dei clienti per generare documenti nei formati PDF, PS, PCL, DPL, IPL e ZPL.

Considerare uno scenario in cui si dispone di uno o più modelli e più record di dati XML per ciascun modello. Puoi utilizzare le API di comunicazione per generare un documento di stampa per ogni record. Il risultato è un documento PDF non interattivo. Un documento PDF non interattivo non consente agli utenti di immettere dati nei campi.

Le comunicazioni forniscono API per la generazione di documenti on-demand e pianificati. Puoi utilizzare le API sincrone per le API on-demand e batch (API asincrone) per la generazione pianificata dei documenti:

• Le API sincrone sono adatte a casi d’uso on-demand, a bassa latenza e per la generazione di documenti a record singolo. Queste API sono più adatte ai casi d’uso basati su azioni dell’utente. Ad esempio, la generazione di un documento dopo la compilazione da parte dell’utente di un modulo.

• Le API Batch (API asincrone) sono adatte a casi d’uso pianificati di alta velocità per la generazione di documenti multipli. Queste API generano documenti in batch. Ad esempio, bollette telefoniche, dichiarazioni con carta di credito e dichiarazioni con benefit generate ogni mese.

Utilizzare le operazioni sincrone

Un'operazione sincrona è un processo di generazione di documenti in modo lineare. Sono disponibili API separate per:

• Genera un documento di PDF da un modello e vi unisce i dati.
• Generare un documento PostScript (PS), PCL (Printer Command Language), Zebra Printing Language (ZPL) da un file XDP o da un documento PDF.
• Assemblare documenti PDF
• Smontare documenti PDF
• Convertire un documento in un documento conforme a PDF/A
• Convalida di un documento conforme a PDF/A

Autenticazione di una chiamata API

Le operazioni sincrone supportano due tipi di autenticazione:

• Autenticazione di base: L’autenticazione di base è un semplice schema di autenticazione integrato nel protocollo HTTP. Il client invia richieste HTTP con l'intestazione Autorizzazione che contiene la parola Base seguita da uno spazio e da una stringa con codifica base64 username:password. Ad esempio, per autorizzare come amministratore / amministratore il client invia Basic [nome utente stringa codificato base64]: [password della stringa con codifica base64].

• Autenticazione basata su token: L’autenticazione basata su token utilizza un token di accesso (token di autenticazione portatore) per effettuare richieste ad Experience Manager as a Cloud Service. AEM Forms as a Cloud Service fornisce API per recuperare in modo sicuro il token di accesso. Per recuperare e utilizzare il token per autenticare una richiesta:

  1. Recuperare le credenziali as a Cloud Service di Experience Manager dalla Console per sviluppatori.
  2. Installare le credenziali as a Cloud Service di Experience Manager nell’ambiente. (Application Server, Web Server o altri server non AEM) configurati per inviare richieste al servizio cloud (effettuare chiamate).
  3. Generare un token JWT e scambiarlo con le API Adobe IMS per un token di accesso.
  4. Esegui l’API Experience Manager con il token di accesso come token di autenticazione portatore.
  5. Impostare le autorizzazioni appropriate per l’utente dell’account tecnico nell’ambiente Experience Manager.
  NOTA

  Adobe consiglia di utilizzare l’autenticazione basata su token in un ambiente di produzione.

(Solo per le API di generazione dei documenti) Configura risorse e autorizzazioni

Per utilizzare le API sincrone, è necessario quanto segue:

• Modelli PDF o XDP
• Dati da unire con i modelli
• Utenti con privilegi di amministratore di Experience Manager
• Caricare modelli e altre risorse nell’istanza di Cloud Service Experience Manager Forms

(Solo per le API di generazione dei documenti) Carica modelli e altre risorse nell’istanza di Experience Manager

In genere, un'organizzazione dispone di più modelli. Ad esempio, un modello per i rendiconti della carta di credito, i rendiconti benefici e le applicazioni di credito. Carica tutti i modelli XDP e PDF nella tua istanza Experience Manager. Per caricare un modello:

1. Apri l’istanza di Experience Manager .
2. Vai a Forms > Forms e documenti
3. Fai clic su Crea > Cartella e crea una cartella. Apri la cartella.
4. Fai clic su Crea > Carica file e carica i modelli.

Richiamare un’API

La Documentazione di riferimento API fornisce informazioni dettagliate su tutti i parametri, i metodi di autenticazione e i vari servizi forniti dalle API. La documentazione di riferimento API fornisce anche il file di definizione API in formato .yaml. Puoi scaricare il file .yaml e caricarlo su postman per verificare la funzionalità delle API.