文档AEM用户指南

[AEM Forms]{class="badge positive" title="适用于AEM Forms)。"}

AEM Forms Communications API — 概述

最近更新： 2026年7月31日
  • 适用对象：
  • Experience Manager as a Cloud Service

创建对象：

  • Developer
  • User

AEM Forms API提供了一整套云原生API，旨在帮助企业自动执行文档工作流。

AEM Forms API通过两个主控制台进行结构化和访问：

  • Adobe Developer Console (ADC) - Adobe Developer Console是Adobe API、事件、运行时和App Builder的网关。

  • AEM Developer Console - AEM Developer Console提供对环境级别的详细信息、配置、技术帐户和服务凭据的访问权限，以支持操作和集成任务。

不同的API支持不同的身份验证方法。

身份验证方法

不同的Forms API根据其发布时间线使用不同的身份验证方法：

早期的API支持基于JWT的服务器到服务器身份验证，该身份验证通过AEM Developer Console进行配置和管理。 较新的API使用OAuth服务器到服务器身份验证，并通过Adobe Developer Console进行配置。

API分类概述

所有AEM Forms API都分为两个主要部分：

详细信息
自适应表单交付和运行时API
通信API
用途
处理自适应表单交付和运行时操作
文档生成和处理
用例
— 表单渲染
— 数据预填充
— 表单提交
— 草稿管理
— 生成PDF
— 文档合并
— 批次处理
— 打印操作
授权方法
支持OAuth服务器到服务器/用户身份验证方法。
根据API，支持服务器到服务器的身份验证，即JWT或OAuth。 API不能同时支持两种身份验证方法。

AEM Forms通信API

通信API是以文档为中心的操作的主要重点。

下表列出了所有AEM Forms Communications API及其支持的身份验证方法和执行模型：

文档生成API

API端点
描述
执行模型
身份验证方法
/adobe/forms/batch/output/config
为文档生成作业创建新的批次配置。
异步/批处理
JWT
/adobe/forms/batch/output/config/{configName}
检索特定批次配置的详细信息。
异步/批处理
JWT
/adobe/forms/batch/output/config/configs
返回所有可用批处理配置的列表。
异步/批处理
JWT
/adobe/forms/batch/output/config/{configName}/execution
使用配置启动批量输出生成运行。
异步/批处理
JWT
/adobe/forms/batch/output/config/{configName}/execution/{executionId}
检索批处理作业的执行状态。
异步/批处理
JWT
/adobe/forms/batch/output/config/{configName}/executions
列出特定批处理配置的所有正在运行的实例。
异步/批处理
JWT
/adobe/forms/doc/v1/generatePDFOutput
根据模板和数据同步生成PDF输出。
同步
JWT
/adobe/forms/doc/v1/generatePrintedOutput
生成可供打印的输出格式（例如，PCL、PostScript）。
同步
JWT
/adobe/forms/doc/v1/generate/afp
为大容量打印生成AFP输出。
同步
JWT
/adobe/document/generate/pdfform
呈现具有合并数据的PDF表单(XFA/XDP)。
同步
OAuth
/adobe/document/generate/pdfform/jobs/{id}/status
检索PDF表单生成作业的状态。
同步
OAuth
/adobe/document/generate/pdfform/jobs/{id}/result
获取已完成的PDF表单作业的输出/结果。
同步
OAuth

文档操作API

API端点
描述
执行模型
身份验证方法
/adobe/forms/assembler/ddx/invoke
执行DDX指令以组合、拆分或处理PDF。
同步
JWT
/adobe/forms/assembler/pdfa/convert
将PDF文档转换为PDF/A格式。
同步
JWT
/adobe/forms/assembler/pdfa/validate
验证PDF是否符合PDF/A标准
同步
JWT

文档转换API

API端点
描述
执行模型
身份验证方法
/adobe/document/convert/pdftoxdp
将PDF表单转换为XDP格式。
同步
OAuth
/adobe/document/convert/htmltopdf
将HTML文档转换为PDF，同时保留其布局和样式。
同步
OAuth
/adobe/document/convert/pstopdf
将PostScript (PS)文档转换为PDF。
同步
OAuth
/adobe/document/convert/pdftoimage
将PDF文档转换为一个或多个图像文件。
同步
OAuth
/adobe/document/convert/pdftops
将PDF文档转换为PostScript (PS)文档。
同步
OAuth
/adobe/document/transform/flattentransparency
拼合PDF文档中的透明度以提高与打印和文档处理工作流的兼容性。
同步
OAuth
NOTE
HTML到PDF、PostScript到PDF、PDF到图像、PDF到PostScript和Flatten Transparency API都属于率先采用者计划。 您可以从官方电子邮件地址发送到aem-forms-ea@adobe.com以加入早期采用者计划，并请求访问这些功能。

文档提取API

API端点
描述
执行模型
身份验证方法
/adobe/forms/doc/v1/extract/pdfproperties
从PDF中提取属性和结构信息。
同步
OAuth
/adobe/forms/doc/v1/extract/usagerights
提取嵌入到PDF中的使用权限。
同步
OAuth
/adobe/forms/doc/v1/extract/metadata
提取元数据，例如标题、作者和关键字。
同步
OAuth
/adobe/forms/doc/v1/extract/data
从PDF forms中提取表单数据(XML/JSON)。
同步
OAuth
/adobe/document/extract/security
提取安全设置，如权限和加密。
同步
OAuth

Document Transformation API

API端点
描述
执行模型
身份验证方法
/adobe/document/transform/metadata
在PDF文档中更新或添加元数据。
同步
OAuth
/adobe/document/field/signature/add
向PDF添加数字签名字段。
同步
OAuth
/adobe/document/field/signature/clear
清除签名字段的内容。
同步
OAuth
/adobe/document/field/signature/remove
从PDF中删除签名字段。
同步
OAuth

文档Assurance API

API端点
描述
执行模型
身份验证方法
/adobe/document/assure/usagerights
将使用权限应用于PDF（例如，注释、填充、签名）。
同步
OAuth
/adobe/document/assure/encrypt
使用密码或证书安全对PDF进行加密。
同步
OAuth
/adobe/document/assure/decrypt
解密受保护的PDF文档。
同步
OAuth
/adobe/document/assure/sign
对PDF文档进行数字签名。
同步
OAuth
/adobe/document/assure/certify
使用数字证书认证PDF。
同步
OAuth

相关步骤

了解如何为同步（按需）和异步（批处理） Forms Communications API设置环境：

同步API

AEM Forms Communications API — 同步

了解如何为同步（按需）Forms Communications API设置环境，以即时生成或处理文档。

了解详情

异步API

AEM Forms Communications API — 异步（批次）

了解如何为异步（批处理）Forms Communications API设置环境，以计划方式生成或处理多个文档。

了解详情

Related Articles
recommendation-more-help
experience-manager-cloud-service-help-main-toc