Uso del procesamiento sincrónico

Las comunicaciones le permiten crear, ensamblar y entregar comunicaciones personalizadas y orientadas a la marca, como correspondencia comercial, documentos, declaraciones, cartas de procesamiento de reclamaciones, avisos de beneficios, cartas de procesamiento de reclamaciones, facturas mensuales y kits de bienvenida. Puede utilizar las API de comunicaciones para combinar una plantilla (XFA o PDF) con datos de clientes para generar documentos en los formatos PDF, PS, PCL, DPL, IPL y ZPL.

Imagine un escenario en el que tiene una o más plantillas y varios registros de datos XML para cada plantilla. Puede utilizar las API de comunicaciones para generar un documento de impresión para cada registro. El resultado es un documento PDF no interactivo. Un documento PDF no interactivo no permite a los usuarios introducir datos en sus campos.

Las comunicaciones proporcionan API para la generación de documentos bajo demanda y programados. Puede utilizar API sincrónicas para API bajo demanda y por lotes (API asincrónicas) para la generación programada de documentos:

  • Las API sincrónicas son adecuadas para casos de uso de generación de documentos bajo demanda, baja latencia y de registro único. Estas API son más adecuadas para casos de uso basados en acciones del usuario. Por ejemplo, la generación de un documento después de que un usuario rellene un formulario.

  • Las API por lotes (API asíncronas) son adecuadas para casos de uso programados de alto rendimiento y de generación de documentos. Estas API generan documentos por lotes. Por ejemplo, facturas telefónicas, extractos de tarjetas de crédito y extractos de beneficios generados cada mes.

Usar operaciones sincrónicas

Una operación sincrónica es un proceso de generación de documentos de forma lineal. Hay API independientes disponibles para:

  • Genera un documento PDF a partir de una plantilla y combina los datos con ella.
  • Genere un documento PostScript (PS), Printer Command Language (PCL), Zebra Printing Language (ZPL) desde un archivo XDP o documento PDF.
  • Montar los documentos PDF
  • Desmontar los documentos PDF
  • Convertir un documento en documento compatible con el PDF/A
  • Validación de un documento compatible con el PDF/A

Autenticar una llamada de API

Las operaciones sincrónicas admiten dos tipos de autenticación:

(Solo para las API de generación de documentos) Configuración de recursos y permisos

Para utilizar API sincrónicas, se requiere lo siguiente:

  • Plantillas PDF o XDP
  • Datos que se van a combinar con plantillas
  • Usuarios con privilegios de administrador de Experience Manager
  • Cargar plantillas y otros recursos a la instancia de Cloud Service de Experience Manager Forms

(Solo para las API de generación de documentos) Cargar plantillas y otros recursos a la instancia de Experience Manager

Una organización suele tener varias plantillas. Por ejemplo, una plantilla para los extractos de tarjetas de crédito, los estados de beneficios y las solicitudes de reivindicación. Cargue todas estas plantillas XDP y PDF en la instancia de Experience Manager. Para cargar una plantilla:

  1. Abra la instancia de Experience Manager.
  2. Vaya a Forms > Forms y documentos
  3. Haga clic en Crear > Carpeta y cree una carpeta. Abra la carpeta.
  4. Haga clic en Crear > Cargar archivo y cargue las plantillas.

Invocar una API

La variable Documentación de referencia de API proporciona información detallada sobre todos los parámetros, métodos de autenticación y diversos servicios proporcionados por las API. La documentación de referencia de la API también proporciona un archivo de definición de API en formato .yaml. Puede descargar el archivo .yaml y cargarlo en postman para comprobar la funcionalidad de las API.

NOTA

Solo los miembros del grupo de usuarios de formularios pueden acceder a las API de comunicaciones.

En esta página