APIs de comunicação do AEM Forms as a Cloud Service communications-apis-overview
Disponibilidade de Versão
- AEM 6.5: Visão Geral dos Serviços de Documento da AEM
- AEM as a Cloud Service: Este artigo
Introdução
As APIs de comunicação no AEM Forms as a Cloud Service ajudam você a criar documentos aprovados pela marca, personalizados e padronizados para as necessidades de sua empresa. Essas APIs avançadas permitem gerar, manipular e proteger documentos programaticamente, seja sob demanda ou em processos em lote de alto volume.
Principais benefícios
- Geração de documentos simplificada - Crie documentos personalizados mesclando modelos com dados do cliente
- Manipulação poderosa de documentos - Combine, reorganize e valide documentos do PDF de forma programática
- Opções de implantação flexíveis - Use APIs sob demanda para necessidades de baixa latência ou APIs em lote para operações de alta taxa de transferência
- Segurança avançada - Aplique assinaturas digitais, certificação e criptografia para proteger documentos confidenciais
- Arquitetura nativa em nuvem - Aproveite a infraestrutura de nuvem escalável e segura sem sobrecarga de manutenção
Visão geral dos recursos da API
As APIs de comunicação fornecem um conjunto abrangente de recursos de processamento de documentos organizados nas seguintes áreas funcionais:
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 está disponível no formato .yaml. É possível baixar o .yaml e carregá-lo no Postman para verificar a funcionalidade das APIs.
Geração de documentos
As APIs de geração de documentos de comunicações ajudam a combinar um modelo (XFA ou PDF) com dados do cliente (XML) para gerar documentos em formatos de PDF e impressão, como formatos PS, PCL, DPL, IPL e ZPL. Essas APIs utilizam modelos PDF e XFA com Dados XML para gerar um único documento por demanda ou vários documentos usando um trabalho em lote.
Normalmente, você cria um modelo usando o Designer e usa as APIs de comunicações para mesclar dados com o modelo. Seu aplicativo pode enviar o documento de saída para uma impressora de rede, uma impressora local ou para um sistema de armazenamento para arquivamento. Um fluxo de trabalho típico personalizado e pronto para uso é semelhante ao seguinte:
Dependendo do caso de uso, também é possível disponibilizar esses documentos para download através do seu site ou de um servidor de armazenamento.
Principais recursos de geração de documentos
Criar documentos PDF create-pdf-documents
Você pode usar as APIs de geração de documentos para criar um documento PDF baseado em um design de formulário e dados de formulário XML. A saída é um documento PDF não interativo. Ou seja, os usuários não podem inserir ou modificar os dados do formulário. Um fluxo de trabalho básico é mesclar dados de formulário XML a um design de formulário para criar um documento PDF. A ilustração a seguir mostra a mesclagem de um design de formulário e dados de formulário XML para produzir um documento PDF.
Figura: Fluxo de trabalho típico para criar um documento PDF
A API de geração de documento retorna o documento PDF gerado. Opcionalmente, também é possível carregar os PDFs gerados no Armazenamento de blobs do Azure.
O carregamento dos PDFs gerados usando a API de geração de documentos para o recurso de Armazenamento Azure Blob está no Programa Early Adoter. Você pode escrever para aem-forms-ea@adobe.com a partir da sua ID de email oficial para ingressar no programa de adoção antecipada e solicitar acesso ao recurso.
Criar documento PostScript (PS), Printer Command Language (PCL), Zebra Printing Language (ZPL) create-PS-PCL-ZPL-documents
Você pode usar APIs de geração de documentos para criar um documento PostScript (PS), Printer Command Language (PCL) e Zebra Printing Language (ZPL) com base em um design de formulário XDP ou documento do PDF. Essas APIs ajudam a mesclar um design de formulário com dados de formulário para gerar um documento. Você pode salvar o documento em um arquivo e desenvolver um processo personalizado para enviá-lo a uma impressora.
Processamento de dados em lote para criar vários documentos processing-batch-data-to-create-multiple-documents
Você pode usar APIs de geração de documentos para criar documentos separados para cada registro em uma fonte de dados em lote XML. Você pode gerar documentos em massa e em modo assíncrono. Você pode configurar vários parâmetros para a conversão e iniciar o processo em lote.
Manipulação de documentos
As APIs de manipulação de documento de comunicações (transformação de documento) ajudam a combinar e reorganizar documentos do PDF. Normalmente, você cria um DDX e o envia para APIs de manipulação de documentos para montar ou reorganizar um documento. O Documento DDX fornece instruções sobre como usar os documentos de origem para produzir um conjunto de documentos necessários. A documentação de referência do DDX fornece informações detalhadas sobre todas as operações compatíveis.
Principais recursos de manipulação de documentos
Montar documentos PDF
Você pode usar as APIs de manipulação de documentos para montar dois ou mais documentos PDF ou XDP em um único documento PDF ou Portfólio de PDF. Estas são algumas das maneiras pelas quais você pode reunir documentos do PDF:
- Montar um documento PDF simples
- Criar um Portifolio de PDF
- Compilar documentos criptografados
- Montar documentos usando a numeração de Bates
- Nivelar e reunir documentos
Figura: Montagem de um documento PDF simples a partir de vários documentos de PDF
Desmontar documentos PDF
Você pode usar as APIs de manipulação de documentos para desmontar um documento do PDF. As APIs podem extrair páginas do documento de origem ou dividir um documento de origem com base em marcadores. Normalmente, essa tarefa é útil se o documento PDF foi criado originalmente de muitos documentos individuais, como uma coleção de declarações.
- Extrair páginas de um documento de origem
- Dividir um documento de origem com base em marcadores
Figura: Dividir um documento de origem com base em marcadores de vários documentos
Extração de documento
O recurso de extração de documentos está no programa Early Adoter. Você pode escrever para aem-forms-ea@adobe.com a partir da sua ID de email oficial para ingressar no programa de adoção antecipada e solicitar acesso ao recurso.
O serviço de Extração de documentos oferece a capacidade de obter as propriedades de um documento do PDF, como direitos de uso, propriedades e metadados do PDF. Os recursos de extração de documentos são:
- Obtém as propriedades de um documento PDF, como se a PDF tivesse anexos, comentários, sua versão Acrobat e muito mais.
- Extraia os direitos de uso ativados em um documento do PDF, os usuários recuperam os direitos de uso ativados ou desativados em um documento do PDF para extensibilidade do Adobe Acrobat Reader.
- Para obter as informações de metadados presentes em um documento do PDF, os metadados são informações sobre o documento (conforme diferenciado do conteúdo do documento, como texto e gráficos). A Adobe Extensible Metadata Platform (XMP) é um padrão para manipular metadados de documentos. O serviço Utilitários da XMP pode recuperar metadados XMP de documentos do PDF e exportar metadados XMP para documentos do PDF.
A documentação de referência da API fornece informações detalhadas sobre todos os parâmetros, métodos de autenticação e os serviços fornecidos pelas APIs. A documentação de referência da API também está disponível no formato .yaml. É possível baixar o .yaml e carregá-lo no Postman para verificar a funcionalidade das APIs.
Conversão de documentos
Converter e validar documentos compatíveis com PDF/A
As APIs de conversão de documento de comunicações ajudam a Converter um documento do PDF em PDF/A. Você pode usar as APIs para converter um documento PDF em um documento compatível com PDF/A e também para determinar se um documento PDF é compatível com PDF/A. O PDF/A é um formato de arquivamento destinado à preservação do conteúdo do documento a longo prazo. As fontes são incorporadas no documento e o arquivo é descompactado. Como resultado, um documento PDF/A geralmente é maior do que um documento PDF padrão. Além disso, um documento PDF/A não tem conteúdo de áudio e vídeo. Os padrões compatíveis de conformidade do PDF/A incluem o PDF/A-1a, 1b, 2a, 2b, 3a e 3b.
Converter PDF em XDP convert-pdf-to-xdp
O recurso Converter PDF em XDP está no Early Adoter Program. Você pode escrever para aem-forms-ea@adobe.com a partir da sua ID de email oficial para ingressar no programa de adoção antecipada e solicitar acesso ao recurso.
Converte um documento PDF em um arquivo XDP. Para que um documento do PDF seja convertido com êxito em um arquivo XDP, o documento do PDF deve conter um fluxo XFA no dicionário.
Assurance do documento doc-assurance
O serviço DocAssurance inclui as APIs de Assinatura e Criptografia:
APIs de assinatura
As APIs de assinatura permitem que sua organização proteja a segurança e a privacidade dos documentos do Adobe PDF que distribui e recebe. Os recursos de segurança são aplicados ao próprio documento; o documento permanece seguro e controlado durante todo o seu ciclo de vida. O documento permanece seguro além do firewall, quando é baixado offline e quando é enviado de volta à sua organização. Você pode realizar as seguintes tarefas usando as APIs de assinatura:
- Adicione um campo de assinatura visível a um documento do PDF.
- Adicione um campo de assinatura invisível a um documento do PDF.
- Assine o campo de assinatura especificado em um documento do PDF.
- Certificar um documento do PDF
- Remover a assinatura do campo de assinatura especificado em um documento do PDF
- Excluir o campo de assinatura especificado de um documento do PDF
Remova a assinatura do campo de assinatura especificado e exclua o campo de assinatura especificado, de um documento do PDF, que estão disponíveis no programa de adoção antecipada. Você pode escrever para aem-forms-ea@adobe.com a partir da sua ID de email oficial para ingressar no programa de adoção antecipada e solicitar acesso ao recurso.
APIs de criptografia
As APIs de criptografia permitem criptografar e descriptografar documentos. Quando um documento é criptografado, seu conteúdo fica ilegível. Um usuário autorizado pode descriptografar o documento para obter acesso ao conteúdo. Se um documento do PDF for criptografado com uma senha, o usuário deverá especificar a senha aberta para que o documento possa ser visualizado no Adobe Reader ou no Adobe Acrobat.
Você pode realizar essas tarefas usando as APIs de criptografia:
- Criptografar um documento do PDF com uma senha.
- Remova a criptografia baseada em senha de um documento do PDF.
- Recupere o tipo de segurança aplicada a um documento do PDF.
- Retorne o tipo de segurança aplicado a um documento do PDF.
As APIs de Assinatura e de Criptografia são APIs Síncronas.
Utilitários de documento doc-utility
Utilitários de documento com APIs síncronas ajudam a converter documentos entre formatos de arquivo PDF e XDP. Aplique direitos de uso a um documento e extraia os direitos de uso ativados de um documento. Consulte informações sobre um documento do PDF. Detalhes das APIs de direitos de uso são fornecidos abaixo:
APIs de direitos de uso (extensão do Reader)
O recurso Direitos de Uso (Extensão do Reader) está no Programa de Primeiros Adotores. Você pode escrever para aem-forms-ea@adobe.com a partir da sua ID de email oficial para ingressar no programa de adoção antecipada e solicitar acesso ao recurso.
O recurso Direitos de uso permite que sua organização compartilhe facilmente documentos interativos do PDF, estendendo a funcionalidade do Adobe Reader com direitos de uso adicionais. O serviço funciona com o Adobe Reader 7.0 ou posterior e adiciona direitos de uso a um documento do PDF. Essa ação ativa recursos que geralmente não estão disponíveis quando um documento do PDF é aberto usando o Adobe Reader, como adicionar comentários a um documento, preencher formulários e salvar o documento.
Quando os documentos do PDF têm os direitos de uso apropriados adicionados, os recipients podem fazer as seguintes atividades no Adobe Reader:
- Preencha os documentos e formulários do PDF on-line ou off-line, permitindo que os recipients salvem cópias localmente para seus registros e ainda mantenham as informações adicionadas intactas.
- Salve os documentos do PDF em um disco rígido local para manter o documento original e quaisquer comentários, dados ou anexos adicionais.
- Anexe arquivos e clipes de mídia a documentos do PDF.
- Assine, certifique e autentique documentos do PDF aplicando assinaturas digitais usando tecnologias de infraestrutura de chave pública (PKI) padrão do setor.
- Envie documentos PDF preenchidos ou anotados eletronicamente.
- Use os documentos e formulários do PDF como um front-end de desenvolvimento intuitivo para bancos de dados internos e serviços da Web.
- Compartilhe documentos do PDF com outras pessoas para que os revisores possam adicionar comentários usando ferramentas de marcação intuitivas. Essas ferramentas incluem notas adesivas eletrônicas, carimbos, destaques e tachado de texto. As mesmas funções estão disponíveis no Acrobat.
- Suporte à decodificação Forms com código de barras.
Esses recursos de direitos de uso especiais são ativados automaticamente quando um documento do PDF habilitado para direitos é aberto no Adobe Reader. Quando o usuário terminar de trabalhar com um documento habilitado para direitos, essas funções serão novamente desabilitadas no Adobe Reader. Eles permanecem desativados até que o usuário receba outro documento do PDF com direitos ativados.
Ativar ou desativar direitos de uso
Os vários recursos de direitos de uso para estender os serviços do PDF Reader são:
-
Decodificação de códigos de barras: para decodificar códigos de barras dentro do documento do PDF.
-
Comentários: para comentar offline no documento do PDF.
-
Comentários Online: para comentar online no documento do PDF.
-
Assinatura digital: para adicionar assinaturas digitais a um documento do PDF.
-
Campos de Formulário Dinâmicos: para adicionar campos de formulário a um documento do PDF.
-
Páginas de Formulário Dinâmicas: para adicionar páginas de formulário a um documento do PDF.
-
Arquivos Inseridos: para inserir arquivos em um documento do PDF.
-
Importação de dados de formulário: para importar dados de formulário para um documento do PDF.
-
Exportação de dados de formulário: para importar dados de formulário para um documento do PDF.
-
Preenchimento de formulário: para preencher campos de formulário em um documento do PDF.
-
Forms Online: para acessar um serviço Web ou banco de dados de um documento do PDF.
-
Enviar Autônomo: para enviar dados de formulário offline de um documento PDF.
Outros recursos
- Mensagem: a mensagem exibida no Adobe Acrobat Reader ao abrir um documento do PDF com um ou mais direitos de uso aplicados.
- Desbloquear Senha: A senha necessária para abrir um documento PDF criptografado. Normalmente, essa é a senha para abrir o documento, mas se o documento do PDF também estiver protegido por uma senha de permissões, ela poderá ser usada para abri-lo.
Tipos de APIs de Comunicação types
As Comunicações fornecem APIs HTTP para geração de documentos sob demanda e em lote:
-
APIs síncronas são adequadas para cenários sob demanda, baixa latência e geração de documento de registro único. Essas APIs são mais adequadas para casos de uso baseados em ações do usuário. Por exemplo, gerar um documento depois que um usuário conclui o preenchimento de um formulário.
-
APIs em lote (APIs assíncronas) são adequadas para cenários programados, de alta taxa de transferência e de geração de vários documentos. Essas APIs geram documentos em lotes. Por exemplo, contas de telefone, demonstrativos de cartão de crédito e demonstrativos de benefícios são gerados todos os meses.
Integração
O recurso de Comunicações está disponível como um módulo independente e complementar para usuários do Forms as a Cloud Service. Você pode entrar em contato com a equipe de vendas da Adobe ou com seu representante da Adobe para solicitar acesso. A Adobe habilita o acesso para sua organização e fornece os privilégios necessários à pessoa designada como administrador em sua organização. O administrador pode conceder acesso aos desenvolvedores (usuários) do Forms as a Cloud Service de sua organização para usar as APIs.
Após a integração, para ativar o recurso de comunicações para o ambiente Forms as a Cloud Service:
-
Faça logon no Cloud Manager e abra a instância do AEM Forms as a Cloud Service.
-
Abra a opção Editar programa, vá para a guia Soluções e complementos e selecione a opção Forms - Comunicações.
Se você já tiver ativado a variável Forms - Inscrição digital, selecione a opção Forms - complemento Comunicações.
-
Clique em Atualizar.
-
Execute o pipeline de build. Depois que o pipeline do build for bem-sucedido, as APIs de Comunicações são ativadas para o seu ambiente.
# Allow Forms Doc Generation requests/0062 { /type "allow" /method "POST" /url "/adobe/forms/assembler/*" }