AEM Forms Cloud Service Communication APIs

Introduction

What are AEM Forms Communications APIs?

AEM Forms Communications APIs capability offers a suite of APIs designed to empower you in crafting brand-consistent, personalized, and standardized documents. Whether it's business correspondences, statements, claim processing letters, benefit notices, monthly bills, or welcome kits, these APIs streamline the creation process. Additionally, our APIs ensure the security and protection of your documents. With the AEM Forms Communications API, you have the flexibility to seamlessly combine, rearrange, and validate PDF documents to meet your specific needs.

Empowered by tools and programming language support tailored to developers' existing skill sets, you can now effortlessly craft engaging and uniform communication experiences centered around PDF documents.

The AEM Forms Communications APIs encompass three key categories: Document Generation APIs, Document Manipulation APIs, and Document Assurance APIs. These powerful tools are designed to elevate your capabilities, delivering streamlined, faster, and branded experiences. By controlling user interaction with your documents, you can effectively streamline communication workflows, enhancing user engagement and retention.

These APIs are available in two flavors:

• 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.

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

Document Generation API for automating document workflows

The Document Generation APIs allows you to produce high fidelity PDF documents with dynamic data inputs. Using Document Generation API, you can merge your data(for example, XML data) with XFA templates to create dynamic documents for contracts and agreements, invoices, proposals, reports, forms, branded marketing documents and more. Additionally, these APIs provide features to convert XFA documents to PS, PCL, and ZPL formats,

The Document Generation APIs seamlessly integrates with Microsoft Power Automate through user-friendly connectors, providing a hassle-free and efficient integration experience.

Document Manipulation to automate for your document workflows

The Document Manipulation APIs help to combine, rearrange, and validate PDF documents. Typically, you create a DDX and submit it to document manipulation APIs to assemble or rearrange a document. The DDX document provides instructions on how to use the source documents to produce a set of required documents. The DDX reference documentation provides detailed information about all the supported operations.

You can use the document manipulation APIs to convert a PDF document to a PDF/A-compliant document and to determine whether a PDF document is PDF/A-compliant. PDF/A is an archival format meant for long-term preservation of the document's content.

Some examples of document manipulation are:

• Assemble a simple PDF document
• Create a PDF Portfolio
• Assemble encrypted documents
• Assemble documents using Bates numbering
• Flatten and assemble document
• Extract pages from a source document
• Convert to and validate PDF/A-compliant documents
• Divide a source document based on bookmarks

Document Assurance to secure and protect your documents

The Document Assurance APIs help encrypt, decrypt, and digitally sign your documents. When a document is encrypted, its contents become unreadable. You can encrypt the entire PDF document (including its content, metadata, and attachments), everything other than its metadata, or only the attachments. You can also certify a document before it is sent to a user to open by using Acrobat or Adobe Reader, validate a signature that was added to a form by using Acrobat or Adobe Reader, sign a document on behalf of a public notary.

Forms Service APIs

Forms service generates interactive PDF forms for data capture. It can also be used to import or export data to and from an existing interactive PDF form and validate submitted data. Here's a breakdown of its functionalities:

• Rendering Forms: Generate an interactive PDF form from a template created using AEM Forms Designer and, optionally, XML data. This essentially produces a fillable PDF form optionally pre-filled with data.
• Data Extraction and Import: Import data into an existing PDF form as well as extract data from a filled PDF form. Both XDP and XML data formats are supported, and importing to non-XFA PDF forms (also known as AcroForms) additionally supports FDF and XFDF data.
• Data Validation: Validate submitted data, in XDP or XML format, against a template created using AEM Forms Designer.

NOTE: The Document Assurance APIs and Forms Service APIs are under early adopter program. You can write to aem-forms-ea@adobe.com from your official email address to join the early adopter program and request access to the Document Assurance capability.

Community forum and feedback

Customer feedback is particularly valuable as it helps the team validate use cases, guide development, and troubleshoot issues. Comments and questions are always welcome on the Community Forum.

Discover

API References

NOTE: The Document Assurance APIs is under early adopter program. You can write to mailto:aem-forms-ea@adobe.com from your official email id to join the early adopter program and request access to the Document Assurance capability.

Last updated 5/13/2024

Was this helpful?

Yes

No