Página inicialAutenticação

Webhook

Nesta seção, você encontrará informações sobre o funcionamento do Webhook da plataforma Unico IDCloud

Os artigos GetProcess respectivos aos meios de integração, descrevem uma maneira de obter o status de um processo através de uma chamada a um endpoint. Dessa forma, é realizado um polling para receber informações sobre os processos criados. Isso significa que o endpoint pode ser chamado diversas vezes para um mesmo processo para se obter o status mais recente.

Com o uso de webhooks é possível notificar um endpoint específico toda vez que o status de um processo for alterado.

O que é um webhook?​

Webhook é um serviço de notificação sistêmica que permite a integração assíncrona entre sistemas, onde um sistema notifica o outro através de um gatilho. Assim, os webhooks podem manter sistemas atualizados com informações mais recentes sem ser necessária a verificação constante por atualizações através de polling.

Como configurar o Webhook

Para configurar o webhook, são necessárias as seguintes informações:

  • URL de notificação: É o endpoint usado pelo By Unico para as notificações sobre as atualizações de status.

  • Tipo de autenticação: É o método de autenticação usado para invocar o endpoint. As seguintes opções estão disponíveis:

    • OAuth2;

    • Basic Authorization;

    • API Key;

    • Sem autenticação.

  • Para OAuth2 é necessário enviar as seguintes informações:

    • Endpoint do webhook;

    • URL do provedor OAuth2;

    • ClientId do provedor OAuth2;

    • Secret do provedor OAuth2.

  • Para o Basic Authorization é preciso enviar no formato user:pass;

  • Para API Key, é possível enviar em dois formatos:

    • header:value, quando é desejado que o header tenha um nome específico;

    • value: quando o header desejado é o Authorization.

  • Configurações de retentativas: Indica o número de tentativas para o caso de falha na chamada ao endpoint:

    • Número máximo de tentativas;

    • Intervalo entre tentativas (em segundos);

    • Rate limit: Limite máximo de envios simultâneos (máximo: 500);

    • Timeout: Tempo máximo de espera para a resposta do endpoint (em segundos);

  • Status a serem notificados: Atualmente a notificação é enviada sempre que o estado de um processo for alterado. Veja abaixo os status que são notificados para cada tipo de integração:

by Unico
by Client

finished: Processo finalizado.

  • 2: Divegência;

  • 3: Concluído;

  • 4: Cancelado;

  • 5: Erro.

Sobre a autenticação:

A API pode ser protegida por um método de autenticação como Basic Authentication ou API Key. Uma lista de IPs válidos para acesso também pode ser definida para proteção complementar.

Integração com a plataforma Unico IDCloud

Ao configurar um webhook na plataforma, você pode obter informações sobre os processos através de notificações enviadas para um endpoint da API desenvolvida por você para receber essas atualizações.

As informações enviadas pela plataforma para a API são:

by Unico
by Client

  • processId: ID da transação;

  • state: Status da transação;

  • flow: Jornada da transação;

  • lastEvent: Último evento disparado (somente retornamos este parâmetro caso o processo seja expirado);

  • lastEventDescription: Descrição do último evento disparado (somente retornamos este parâmetro caso o processo seja expirado).

  • id: ID da transação;

  • status: Status da transação.

Clique para conferir o enum dos eventos que podem ser retornados no webhook
LastEvent
Description

EVENT_STATE_PROCESS_CREATED

Processo criado

EVENT_STATE_QR_CODE_WAS_READ

QRCode foi lido

EVENT_STATE_SESSION_CREATED

Processo iniciado pelo usuário

EVENT_STATE_SESSION_AUTHENTICATED

Usuário realizou etapa de validação

EVENT_STATE_DOCUMENT_STEP_WAS_STARTED

Etapa de documento foi iniciada

EVENT_STATE_DOCUMENT_PHOTO_TAKEN

Foto do documento foi capturada

EVENT_STATE_DOCUMENT_UPLOADED_FROM_GALLERY

Foi feito upload do documento

EVENT_STATE_DOCUMENT_STEP_WAS_FINISHED

Etapa do documento foi finalizada

EVENT_STATE_START_SIGNATURE

Etapa de assinatura foi iniciada

EVENT_STATE_DOCUMENT_ACCEPTED

Etapa de assinatura do documento foi aceita

EVENT_STATE_ENVELOPE_OPENED

Envelope foi aberto para assinatura

EVENT_STATE_DOCUMENT_VIEWED

Documento para assinatura foi visualizado

EVENT_STATE_DOCUMENT_SIGNED

Documento foi assinado

EVENT_STATE_SIGNATURE_STEP_FINISHED

Etapa de assinatura do documento foi finalizada

EVENT_STATE_ERROR_ON_DOCUMENT_STEP

Erro na etapa do documento

EVENT_STATE_ERROR_ON_SIGNATURE_STEP

Erro na etapa da assinatura

Requisições​

A requisição deve ser um método POST em uma API REST tornando mais fácil e seguro o envio das informações. Todos os campos devem ser obrigatórios. O corpo da requisição deve aceitar o ID da transação e o estado, como mostrado no exemplo a seguir:

{
  "processId": "8263a268-5388-492a-bca2-28e1ff4a69f0",
  "state": "PROCESS_STATE_FINISHED",
  "flow": "id",
  "lastEvent":"EVENT_TYPE_PROCESS_CREATED",
  "lastEventDescription":"Process created"
}

Sobre o status de resposta:

Atualmente a plataforma tem um conjunto de status que pode variar no futuro. Sendo assim, é recomendado que os status que o você tem interesse para tomar alguma ação sejam configuráveis.

Resposta

A resposta deve vir de forma síncrona. O status para requisições bem sucedidas deve estar no intervalo de 200 a 299. Qualquer outro status é considerado falha e então a plataforma realiza novas tentativas de notificações (com exponential backoff entre elas), até receber uma resposta 2xx ou até atingir o número máximo de tentativas.

Rate limit

Com intuito de não sobrecarregar seus recursos em situações de muitas transações, é possível especificar um limite superior de vezes em que o endpoint pode ser invocado.

Taxa de erros

A taxa de erros (respostas fora do intervalo de [200, 299]) deve ser sempre baixa. Caso contrário, o throughput do webhook será automaticamente reduzido, e essa redução junto ao mecanismo do retry pode implicar no aumento do tempo de execução de novos webhooks.

Idempotência

A atual implementação de webhook possui a garantia de at-least once delivery, portanto o mesmo status pode ser notificado mais de uma vez. Sendo assim, a implementação do endpoint deve ser feita de maneira idempotente.

Fallback

Em caso de alguma indisponibilidade no serviço do webhook, é recomendado que exista um método de fallback para que você possa continuar obtendo os status das transações dentro do tempo de resposta estabelecido. A consulta ao endpoint está descrita nas seções de GetProcess respectivas a cada meio de integração.

Dúvidas?​

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

AnteriorPadrão de captura (sem SDK)PróximoSDK

Atualizado