Use synchronous processing

Communications allows you to create, assemble, and deliver brand-oriented and personalized communications such as business correspondences, documents, statements, claim processing letters, benefit notices, claim processing letters, monthly bills, and welcome kits. You can use Communications APIs to combine a template (XFA or PDF) with customer data to generate documents in PDF, PS, PCL, DPL, IPL, and ZPL formats.

Consider a scenario where you have one or more templates and multiple records of XML data for each template. You can use Communications APIs to generate a print document for each record. The result is a non-interactive PDF document. A non-interactive PDF document does not let users enter data into its fields.

Communications provide APIs for on-demand and scheduled document generation. You can use synchronous APIs for on-demand and batch APIs (asynchronous APIs) for scheduled document generation:

  • Synchronous APIs are suitable for on-demand, low latency, and single record document generation use cases. These APIs are more suitable for user-action based use cases. For example, generating a document after a user fill a form.

  • Batch APIs (Asynchronous APIs) are suitable for scheduled high throughput multiple document generation use cases. These APIs generate documents in batches. For example, phone bills, credit card statements, and benefits statements generated every month.

Use Synchronous operations

A synchronous operation is a process of generating documents in a linear manner. Separate APIs are available to:

  • Generates a PDF Document from a template and merge data to it.
  • Generate a PostScript (PS), Printer Command Language (PCL), Zebra Printing Language (ZPL) document from an XDP file or PDF document.
  • Assemble PDF documents
  • Disassemble PDF documents
  • Convert a document to PDF/A-compliant document
  • Validate a PDF/A-compliant document

Authenticate an API call

Synchronous operations support two type of authentication:

(Only for Document Generation APIs) Configure assets and permissions

To use Synchronous APIs, the following is required:

  • PDF or XDP templates
  • Data to be merged with templates
  • Users with Experience Manager administrator privileges
  • Upload templates and other assets to your Experience Manager Forms Cloud Service instance

(Only for Document Generation APIs) Upload templates and other assets to your Experience Manager instance

An organization typically has multiple templates. For example, one template each for credit card statements, benefits statements, and claim applications. Upload all such XDP and PDF templates to your Experience Manager instance. To upload a template:

  1. Open you Experience Manager instance.
  2. Go to Forms > Forms and Documents
  3. Click Create > Folder and create a folder. Open the folder.
  4. Click Create > File Upload and upload the templates.

Invoke an API

The API reference documentation provides detailed information about all the parameters, authentication methods, and various services provided by APIs. The API reference documentation is also provides API defination file in the .yaml format. You can download the .yaml file and upload it to postman to check functionality of the APIs.

NOTE

Only members of forms-users group can access Communications APIs.

On this page