API de comunicaciones AEM Forms: Información general

Las API de AEM Forms proporcionan un completo conjunto de API nativas de la nube diseñadas para ayudar a las empresas a automatizar los flujos de trabajo de los documentos.

Las API de AEM Forms están estructuradas y se accede a ellas a través de dos consolas principales:

  • Adobe Developer Console (ADC): Adobe Developer Console es la puerta de enlace a las API de Adobe, los eventos, el tiempo de ejecución y App Builder.

  • AEM Developer Console: AEM Developer Console proporciona acceso a detalles, configuraciones, cuentas técnicas y credenciales de servicio a nivel de entorno para admitir tareas operativas y de integración.

Diferentes API admiten diferentes métodos de autenticación.

Métodos de autenticación

Las distintas API de Forms utilizan diferentes métodos de autenticación en función de su cronología de lanzamiento:

Las API anteriores admiten la autenticación de servidor a servidor basada en JWT, que se configura y administra mediante AEM Developer Console. Las API más recientes utilizan la autenticación de servidor a servidor OAuth y se configuran mediante Adobe Developer Console.

Resumen de clasificación de API

Todas las API de AEM Forms se dividen en dos partes principales:

Detalles
API de tiempo de ejecución y entrega de formularios adaptables
API de comunicación
Función
Administrar las operaciones de tiempo de ejecución y entrega de formularios adaptables
Generación y manipulación de documentos
Casos de uso
- Procesamiento de formularios
- Relleno previo de datos
- Envíos de formularios
- Administración de borradores
- Generación de PDF
- Combinación de documentos
- Procesamiento por lotes
- Operaciones de impresión
Método de autorización
Admite métodos de autenticación de servidor a servidor/usuario de OAuth.
Admite la autenticación de servidor a servidor, ya sea JWT o OAuth según la API. Una API no puede admitir ambos métodos de autenticación.

API de comunicaciones de AEM Forms

Las API de comunicación son el enfoque principal de las operaciones centradas en los documentos.

En la tabla siguiente se enumeran todas las API de comunicaciones de AEM Forms junto con los métodos de autenticación y modelos de ejecución admitidos:

API de generación de documentos

Punto final de API
Descripción
Modelo de ejecución
Método de autenticación
/adobe/forms/batch/output/config
Crea una nueva configuración por lotes para los trabajos de generación de documentos.
Asincrónica/Por Lotes
JWT
/adobe/forms/batch/output/config/{configName}
Recupera detalles de una configuración de lote específica.
Asincrónica/Por Lotes
JWT
/adobe/forms/batch/output/config/configs
Devuelve una lista de todas las configuraciones por lotes disponibles.
Asincrónica/Por Lotes
JWT
/adobe/forms/batch/output/config/{configName}/execution
Inicia una ejecución de generación de resultados por lotes utilizando una configuración.
Asincrónica/Por Lotes
JWT
/adobe/forms/batch/output/config/{configName}/execution/{executionId}
Recupera el estado de ejecución de un trabajo por lotes.
Asincrónica/Por Lotes
JWT
/adobe/forms/batch/output/config/{configName}/executions
Enumera todas las instancias en ejecución para una configuración por lotes específica.
Asincrónica/Por Lotes
JWT
/adobe/forms/doc/v1/generatePDFOutput
Genera resultados de PDF de forma sincrónica en función de plantillas y datos.
Sincrónica
JWT
/adobe/forms/doc/v1/generatePrintedOutput
Genera formatos de salida listos para imprimir (por ejemplo, PCL, PostScript).
Sincrónica
JWT
/adobe/forms/doc/v1/generate/afp
Genera salida AFP para impresión de gran volumen.
Sincrónica
JWT
/adobe/document/generate/pdfform
Procesa un formulario PDF Forms (XFA/XDP) con datos combinados.
Sincrónica
OAuth
/adobe/document/generate/pdfform/jobs/{id}/status
Recupera el estado de un trabajo de generación de formularios de PDF.
Sincrónica
OAuth
/adobe/document/generate/pdfform/jobs/{id}/result
Obtiene el resultado de un trabajo de formulario de PDF completado.
Sincrónica
OAuth

API de manipulación de documentos

Punto final de API
Descripción
Modelo de ejecución
Método de autenticación
/adobe/forms/assembler/ddx/invoke
Ejecuta instrucciones DDX para combinar, dividir o manipular archivos PDF.
Sincrónica
JWT
/adobe/forms/assembler/pdfa/convert
Convierte un documento de PDF al formato PDF/A.
Sincrónica
JWT
/adobe/forms/assembler/pdfa/validate
Valida si un PDF cumple el estándar PDF/A.
Sincrónica
JWT

API de conversión de documentos

Punto final de API
Descripción
Modelo de ejecución
Método de autenticación
/adobe/document/convert/pdftoxdp
Convierte un formulario PDF en formato XDP.
Sincrónica
OAuth

API de extracción de documento

Punto final de API
Descripción
Modelo de ejecución
Método de autenticación
/adobe/forms/doc/v1/extract/pdfproperties
Extrae propiedades e información estructural de una PDF.
Sincrónica
OAuth
/adobe/forms/doc/v1/extract/usagerights
Extrae los derechos de uso incrustados en un PDF.
Sincrónica
OAuth
/adobe/forms/doc/v1/extract/metadata
Extrae metadatos como título, autor y palabras clave.
Sincrónica
OAuth
/adobe/forms/doc/v1/extract/data
Extrae datos de formulario (XML/JSON) de PDF forms.
Sincrónica
OAuth
/adobe/document/extract/security
Extrae la configuración de seguridad, como permisos y cifrado.
Sincrónica
OAuth

API de transformación de documento

Punto final de API
Descripción
Modelo de ejecución
Método de autenticación
/adobe/document/transform/metadata
Actualiza o agrega metadatos en un documento de PDF.
Sincrónica
OAuth
/adobe/document/field/signature/add
Agrega un campo de firma digital a un PDF.
Sincrónica
OAuth
/adobe/document/field/signature/clear
Borra el contenido de un campo de firma.
Sincrónica
OAuth
/adobe/document/field/signature/remove
Quita un campo de firma de un PDF.
Sincrónica
OAuth

API de Document Assurance

Punto final de API
Descripción
Modelo de ejecución
Método de autenticación
/adobe/document/assurance/usagerights
Aplica derechos de uso a un PDF (por ejemplo, comentario, relleno, firma).
Sincrónica
OAuth
/adobe/document/secure/encrypt
Codifica un PDF con contraseña o seguridad de certificado.
Sincrónica
OAuth
/adobe/document/assurance/decrypt
Descifra un documento de PDF protegido.
Sincrónica
OAuth
/adobe/document/assurance/sign
Firma digitalmente un documento de PDF.
Sincrónica
OAuth
/adobe/document/assurance/certificfy
Certifica un PDF con un certificado digital.
Sincrónica
OAuth

Pasos relacionados

Obtenga información sobre cómo establecer el entorno para las API de comunicaciones de Forms sincrónicas (bajo demanda) y asincrónicas (por lotes):

API sincrónicas

API de comunicaciones de AEM Forms: sincrónicas

Aprenda a configurar un entorno para las API de comunicaciones de Forms sincrónicas (bajo demanda) que generan o procesan documentos al instante.

Más información

API asíncronas

API de comunicaciones de AEM Forms: asincrónicas (por lotes)

Aprenda a configurar el entorno para las API de comunicaciones de Forms asincrónicas (por lotes) que generan o procesan varios documentos de forma programada.

Más información

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