Usar processamento síncrono sync-processing-introduction
As APIs de comunicações do Forms as a Cloud Service permitem criar, montar e fornecer comunicações personalizadas e orientadas à marca, como correspondências comerciais, documentos, declarações, cartas de processamento de solicitações, avisos de benefícios, cartas de processamento de solicitações, faturas mensais e kits de boas-vindas. Você pode usar APIs de comunicações para combinar um modelo (XFA ou PDF) com os dados do cliente para gerar documentos nos formatos PDF, PS, PCL, DPL, IPL e ZPL.
Considere um cenário em que você tem um ou mais modelos e vários registros de dados XML para cada modelo. Você pode usar APIs de comunicações para gerar um documento de impressão para cada registro. O resultado é um documento PDF não interativo. Um documento PDF não interativo não permite que os usuários insiram dados em seus campos.
O Forms as a Cloud Service - Communications fornece APIs sob demanda e em lote (APIs assíncronas) para a geração programada de documentos:
-
As APIs síncronas são adequadas para casos de uso de geração de documento de registro único, latência baixa e sob demanda. Essas APIs são mais adequadas para casos de uso baseados em ações do usuário. Por exemplo, gerar um documento após um usuário preencher um formulário.
-
As APIs em lote (APIs assíncronas) são adequadas para casos de uso programados de alta taxa de transferência na geração de vários documentos. Essas APIs geram documentos em lotes. Por exemplo, contas telefônicas, demonstrativos de cartão de crédito e demonstrativos de benefícios gerados todo mês.
Usar operações síncronas batch-operations
Uma operação síncrona é um processo de geração de documentos de maneira linear. Essas APIs são classificadas como APIs de locatário único e APIs de vários locatários:
APIs de locatário único
- APIs de geração de documentos
- APIs de manipulação de documentos
Autenticar uma API de locatário único
As operações de API de locatário único oferecem suporte a dois tipos de autenticação:
-
Autenticação básica: a autenticação básica é um esquema de autenticação simples incorporado ao protocolo HTTP. O cliente envia solicitações HTTP com o cabeçalho de Autorização que contém a palavra Básico seguida por um espaço e uma string codificada em base64 username:password. Por exemplo, para autorizar como administrador / administrador, o cliente envia o nome de usuário ] da cadeia de caracteres codificada em [base64 Básico: [senha da cadeia de caracteres codificada em base64].
-
Autenticação baseada em token: a autenticação baseada em token usa um token de acesso (token de autenticação de portador) para fazer solicitações ao Experience Manager as a Cloud Service. O AEM Forms as a Cloud Service fornece APIs para recuperar com segurança o token de acesso. Para recuperar e usar o token para autenticar uma solicitação:
- Experience Manager Recupere a credencial as a Cloud Service do Developer Console.
- Instalar o Experience Manager as a Cloud Service credential em seu ambiente. (Servidor de Aplicativos, Servidor Web ou outros servidores que não sejam AEM) configurados para enviar solicitações ao (efetuar chamadas) Cloud Service.
- Gerar um token JWT e trocá-lo com APIs do Adobe IMS por um token de acesso.
- Execute a API de Experience Manager com o token de acesso como um token de autenticação de portador.
- Defina as permissões apropriadas para o usuário da conta técnica no ambiente de Experience Manager.
note note NOTE A Adobe recomenda usar a autenticação baseada em token em um ambiente de produção.
(Somente para APIs de geração de documento) Configurar ativos e permissões
Para usar APIs síncronas, é necessário o seguinte:
- Usuários com privilégios de administrador de Experience Manager
- Faça upload de modelos e outros ativos para sua instância do Experience Manager Forms Cloud Service
(Somente para APIs de geração de documento) Faça upload de modelos e outros ativos para sua instância do Experience Manager
Uma organização normalmente tem vários modelos. Por exemplo, um modelo para demonstrativos de cartão de crédito, demonstrativos de benefícios e aplicações de reivindicação. Faça upload de todos esses modelos XDP e PDF para sua instância Experience Manager. Para fazer upload de um modelo:
- Abra a instância do Experience Manager.
- Vá até Forms > Forms e Documentos
- Clique em Criar > Pasta e crie uma pasta. Abra a pasta.
- Clique em Criar > Upload de arquivo e faça upload dos modelos.
Chamar uma API
A documentação de referência da API fornece informações detalhadas sobre todos os parâmetros, métodos de autenticação e vários serviços fornecidos por APIs. A documentação de referência da API também fornece o arquivo de definição de API no formato .yaml. Você pode baixar o arquivo .yaml e carregá-lo no Postman para verificar a funcionalidade das APIs.