APIs de comunicações do AEM Forms - Visão geral

As APIs do AEM Forms fornecem um conjunto abrangente de APIs nativas em nuvem criadas para ajudar as empresas a automatizar fluxos de trabalho de documentos.

As APIs do AEM Forms são estruturadas e acessadas por meio de dois consoles principais:

  • Adobe Developer Console (ADC) - O Adobe Developer Console é o gateway para APIs, Eventos, Tempo de Execução e App Builder da Adobe.

  • AEM Developer Console - O AEM Developer Console fornece acesso a detalhes, configurações, contas técnicas e credenciais de serviço no nível do ambiente para oferecer suporte a tarefas operacionais e de integração.

APIs diferentes suportam métodos de autenticação diferentes.

Métodos de autenticação

Diferentes APIs do Forms usam diferentes métodos de autenticação com base na linha do tempo de lançamento:

As APIs anteriores oferecem suporte à autenticação de servidor para servidor baseada em JWT, que é configurada e gerenciada por meio do AEM Developer Console. As APIs mais recentes usam a autenticação de servidor para servidor OAuth e são configuradas por meio do Adobe Developer Console.

Visão geral da classificação de API

Todas as APIs do AEM Forms estão divididas em duas partes principais:

Detalhes
APIs de entrega e tempo de execução de formulários adaptáveis
APIs de comunicação
Propósito
Lidar com operações de entrega e tempo de execução do Formulário adaptável
Geração e manipulação de documentos
Casos de uso
- Renderização do formulário
- Preenchimento prévio de dados
- Envios de formulário
- Gerenciamento de rascunhos
- Geração de PDF
- Mesclagem de documentos
- Processamento em lote
- Operações de impressão
Método de autorização
Suporta métodos de autenticação de servidor para servidor/usuário OAuth.
Oferece suporte à autenticação de servidor para servidor, JWT ou OAuth, dependendo da API. Uma API não pode suportar ambos os métodos de autenticação.

APIs de comunicações do AEM Forms

As APIs de comunicação são o foco principal das operações centradas em documentos.

A tabela abaixo lista todas as APIs de Comunicações do AEM Forms, juntamente com seus métodos de autenticação e modelos de execução compatíveis:

APIs de geração de documento

Endpoint da API
Descrição
Modelo de execução
Método de autenticação
/adobe/forms/batch/output/config
Cria uma nova configuração de lote para trabalhos de geração de documento.
Assíncrono/Em Lote
JWT
/adobe/forms/batch/output/config/{configName}
Recupera detalhes de uma configuração de lote específica.
Assíncrono/Em Lote
JWT
/adobe/forms/batch/output/config/configs
Retorna uma lista de todas as configurações de lote disponíveis.
Assíncrono/Em Lote
JWT
/adobe/forms/batch/output/config/{configName}/execution
Inicia uma execução de geração de saída em lote usando uma configuração.
Assíncrono/Em Lote
JWT
/adobe/forms/batch/output/config/{configName}/execution/{executionId}
Recupera o status de execução de um trabalho em lotes.
Assíncrono/Em Lote
JWT
/adobe/forms/batch/output/config/{configName}/executions
Lista todas as instâncias em execução de uma configuração de lote específica.
Assíncrono/Em Lote
JWT
/adobe/forms/doc/v1/generatePDFOutput
Gera saída do PDF de forma síncrona com base em modelos e dados.
Sincrônico
JWT
/adobe/forms/doc/v1/generatePrintedOutput
Gera formatos de saída prontos para impressão (por exemplo, PCL, PostScript).
Sincrônico
JWT
/adobe/forms/doc/v1/generate/afp
Gera saída AFP para impressão em alto volume.
Sincrônico
JWT
/adobe/document/generate/pdfform
Renderiza um formulário do PDF (XFA/XDP) com dados mesclados.
Sincrônico
OAuth
/adobe/document/generate/pdfform/jobs/{id}/status
Recupera o status de um trabalho de geração de formulário do PDF.
Sincrônico
OAuth
/adobe/document/generate/pdfform/jobs/{id}/result
Busca a saída/resultado de um trabalho de formulário do PDF concluído.
Sincrônico
OAuth

APIs de manipulação de documentos

Endpoint da API
Descrição
Modelo de execução
Método de autenticação
/adobe/forms/assembler/ddx/invoke
Executa instruções do DDX para combinar, dividir ou manipular PDFs.
Sincrônico
JWT
/adobe/forms/assembler/pdfa/convert
Converte um documento do PDF no formato PDF/A.
Sincrônico
JWT
/adobe/forms/assembler/pdfa/validate
Valida se um PDF está em conformidade com o padrão PDF/A
Sincrônico
JWT

APIs de conversão de documento

Endpoint da API
Descrição
Modelo de execução
Método de autenticação
/adobe/document/convert/pdftoxdp
Converte um formulário do PDF em formato XDP.
Sincrônico
OAuth

APIs de extração de documento

Endpoint da API
Descrição
Modelo de execução
Método de autenticação
/adobe/forms/doc/v1/extract/pdfproperties
Extrai propriedades e informações estruturais de uma PDF.
Sincrônico
OAuth
/adobe/forms/doc/v1/extract/usagerrights
Extrai direitos de uso incorporados em uma PDF.
Sincrônico
OAuth
/adobe/forms/doc/v1/extract/metadata
Extrai metadados como título, autor e palavras-chave.
Sincrônico
OAuth
/adobe/forms/doc/v1/extract/data
Extrai dados de formulário (XML/JSON) do PDF forms.
Sincrônico
OAuth
/adobe/document/extract/security
Extrai configurações de segurança, como permissões e criptografia.
Sincrônico
OAuth

APIs de transformação de documento

Endpoint da API
Descrição
Modelo de execução
Método de autenticação
/adobe/document/transform/metadata
Atualiza ou adiciona metadados em um documento do PDF.
Sincrônico
OAuth
/adobe/document/field/signature/add
Adiciona um campo de assinatura digital a uma PDF.
Sincrônico
OAuth
/adobe/document/field/signature/clear
Limpa o conteúdo de um campo de assinatura.
Sincrônico
OAuth
/adobe/document/field/signature/remove
Remove um campo de assinatura de uma PDF.
Sincrônico
OAuth

Documentar APIs do Assurance

Endpoint da API
Descrição
Modelo de execução
Método de autenticação
/adobe/document/sure/usagerrights
Aplica direitos de uso a uma PDF (por exemplo, comentário, preenchimento, sinal).
Sincrônico
OAuth
/adobe/document/sure/encrypt
Criptografa uma PDF com segurança de senha ou certificado.
Sincrônico
OAuth
/adobe/document/sure/decrypt
Descriptografa um documento PDF protegido.
Sincrônico
OAuth
/adobe/document/sure/sign
Assina digitalmente um documento do PDF.
Sincrônico
OAuth
/adobe/document/sure/certify
Certifica uma PDF com um certificado digital.
Sincrônico
OAuth

Etapas relacionadas

Saiba como definir o ambiente para APIs de comunicações síncronas (sob demanda) e assíncronas (em lote) do Forms:

APIs síncronas

APIs de Comunicações do AEM Forms - Síncronas

Saiba como configurar um ambiente para APIs síncronas (sob demanda) de comunicações do Forms que geram ou processam documentos instantaneamente.

Saiba mais

APIs assíncronas

APIs de Comunicações do AEM Forms - Assíncrono (Lote)

Saiba como configurar um ambiente para APIs assíncronas (em lote) de comunicações do Forms que geram ou processam vários documentos de maneira programada.

Saiba mais

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