Usar el procesamiento sincrónico

Las API de comunicaciones as a Cloud Service de Forms le permiten crear, montar 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 en 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 los campos.

Forms as a Cloud Service: Comunicaciones proporciona la 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, con baja latencia y de registro único. Estas API son más adecuadas para casos de uso basados en las acciones del usuario. Por ejemplo, generar un documento después de que un usuario rellene un formulario.

• Las API por lotes (API asíncronas) son adecuadas para casos de uso planificados de alto rendimiento y de generación de múltiples documentos. Estas API generan documentos por lotes. Por ejemplo, facturas telefónicas, extractos de tarjetas de crédito y declaraciones 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. Estas API están clasificadas como de un solo inquilino y de varios:

API de un solo inquilino

• API de generación de documentos
• API de manipulación de documentos

Autenticación de una API de un solo inquilino

Las operaciones de API de un solo inquilino admiten dos tipos de autenticación:

• Autenticación básica: la autenticación básica es un esquema de autenticación simple integrado en el protocolo HTTP. El cliente envía peticiones HTTP con el encabezado Autorización que contiene la palabra “Basic” seguida de un espacio y un nombre de usuario:contraseña de cadena codificados en Base64. Por ejemplo, para autorizar como administrador/administrador, el cliente envía Basic [nombre de usuario de cadena codificado en Base64]: [contraseña de cadena codificada en Base64].

• Autenticación basada en tokens: la autenticación basada en tokens utiliza un token de acceso (token de autenticación del portador) para realizar solicitudes a Experience Manager as a Cloud Service. AEM Forms as a Cloud Service proporciona API para recuperar de forma segura el token de acceso. Para recuperar y utilizar el token para autenticar una solicitud:

  1. Recupere las credenciales de Experience Manager as a Cloud Service desde Developer Console.
  2. Instale las credenciales de Experience Manager as a Cloud Service en su entorno. (Servidor de aplicaciones, servidor web u otros servidores no AEM) configurados para enviar solicitudes (realizar llamadas) al servicio en la nube.
  3. Genere un token JWT e intercámbielo con las API de IMS de Adobe por un token de acceso.
  4. Ejecute la API de Experience Manager con el token de acceso como token de autenticación del portador.
  5. Establezca los permisos adecuados para el usuario de la cuenta técnica en el entorno de Experience Manager.
  NOTA

  Adobe recomienda utilizar la autenticación basada en token en un entorno de producció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:

• Usuarios con privilegios de administrador en Experience Manager
• Cargue plantillas y otros recursos a su instancia de Experience Manager Forms Cloud Service

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

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

1. Abra su instancia de Experience Manager.
2. Vaya a Formularios > Formularios 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 documentación de referencia de la API ofrece información detallada sobre todos los parámetros, métodos de autenticación y diversos servicios que ofrecen 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.

Recursos de Business.Adobe.com