Primeira requisição

Este passo a passo segue o fluxo recomendado de integração do Autentica: você escolhe o fluxo, consulta os perfis, cria um pedido com as partes e acompanha até obter o resultado.

Pré-requisitos

Credenciais

Ter suas credenciais de aplicação (Client ID e Secret).

Token de acesso

Ter gerado um token de acesso — veja Autenticação.

Os caminhos exatos de cada endpoint (rota, parâmetros e corpo) estão na Referência técnica (API). Aqui o foco é a ordem das operações e o que cada passo produz.

Passo 1

Consulte os fluxos disponíveis

Use o controller de Fluxos para listar os fluxos de coleta e assinatura publicados e liberados para a sua empresa. Escolha o fluxo adequado à operação e guarde o identificador do fluxo. Alguns fluxos possuem anexos padrão, que são adicionados automaticamente às solicitações criadas com aquele fluxo.

Antes de abrir um pedido, confirme que o fluxo escolhido está publicado e liberado. Um fluxo inválido ou indisponível impede a criação do pedido.

Passo 2

Consulte os perfis

Use o controller de Perfis para identificar os perfis disponíveis e os campos exigidos por cada um. O perfil define os campos obrigatórios e opcionais que a parte precisará preencher — escolha conforme o papel da pessoa ou empresa na operação.

Passo 3

Prepare os documentos (quando necessário)

Se o fluxo exigir o envio de arquivos, use o controller de Arquivos para obter um link temporário de upload e enviar o documento. O processo é:

Solicite o link

Peça um link temporário de upload e receba a URL e o identificador do arquivo.

Envie o arquivo

Faça o upload do documento diretamente para a URL recebida.

Associe ao pedido

Use o identificador do arquivo ao montar o pedido ou a parte.

As URLs de upload são temporárias. Utilize-as imediatamente, dentro do período de validade informado pela API.

Passo 4

Crie o pedido

Use o controller de Pedidos para criar a solicitação, reunindo:

Informação	Descrição
Fluxo	Identificador do fluxo de coleta/assinatura escolhido no passo 1.
Partes	Uma ou mais pessoas/empresas envolvidas (CPF/CNPJ, nome, celular, e-mail).
Perfil de cada parte	Perfil que define os campos exigidos, conforme o passo 2.
Dados cadastrais e campos	Os campos obrigatórios do perfil, devidamente preenchidos.
Documentos e anexos	Arquivos enviados no passo 3 e anexos globais, quando houver.

Em caso de sucesso, guarde o identificador do pedido — ele é usado em todas as consultas e operações seguintes.

Valide os campos obrigatórios de cada perfil antes de enviar. Em caso de timeout, não recrie o pedido sem antes verificar o resultado da operação, para evitar duplicidade.

Passo 5

Envie o link de acesso

Cada parte recebe um link de acesso ao fluxo, obtido pelo controller de Partes. Encaminhe-o pelo canal definido no processo (e-mail, SMS, aplicação própria ou portal integrado).

O link de acesso é informação sensível. Não o exponha em logs, mensagens públicas ou repositórios.

Passo 6

Acompanhe o andamento

Acompanhe o status da parte e do pedido por consulta ou, preferencialmente, por webhook. Situações típicas do controle do processo:

Situação	Significado
Aguardando início	A parte ainda não iniciou o fluxo.
Em andamento	A parte está executando as etapas do fluxo.
Finalizada	A parte concluiu o fluxo.
Aprovada / Reprovada	Resultado da análise da parte, conforme as regras do processo.
Cancelada	A parte foi cancelada.

Os valores exatos de status devem ser tratados conforme o retorno da API e a configuração do fluxo utilizado.

Passo 7

Obtenha o resultado

Após a finalização:

Consulte o resultado do pedido ou da parte;
Baixe os documentos (enviados, coletados, assinados e de auditoria) pelo controller de Arquivos, usando as URLs temporárias imediatamente;
Gere o PDF da parte finalizada pelo controller de PDF, com dados cadastrais, evidências, informações da assinatura e carimbo do tempo;
Armazene as evidências e atualize o status no seu sistema.

Tratamento de erros

Implemente tratamento para os principais erros previstos na documentação:

Categoria	Tratamento recomendado
Autenticação / Autorização	Verificar o token e as permissões da aplicação.
Dados obrigatórios ausentes / Documento inválido	Validar os campos do perfil e os documentos antes do envio.
Fluxo inválido ou indisponível	Confirmar que o fluxo está publicado e liberado.
Parte não encontrada / Pedido inexistente	Conferir os identificadores armazenados.
Operação não permitida para o status atual	Consultar o status antes de agir sobre a parte.
Timeout / Indisponibilidade / Falha de upload	Usar retentativas com intervalo progressivo, sem duplicar pedidos.

Próximo passo

Veja como aplicar esse fluxo em cenários reais nos casos de uso.