O documento a seguir tem por objetivo orientar as integrações sobre as jornadas principais utilizando as APIS do TAE  - TOTVS Assinatura Eletrônica.

deck.tab.active.background = #FFFFFF
deck.tab.inactive.background = #FFFFFF

deck.card.border = 4px black
deck.card.background = #F6F9F9

Mantenha os status dos documentos atualizados na integração através dos webhooks


Configurar webhooks para acompanhar vários eventos, incluindo documento finalizado, documento excluído, assinatura realizada, documento rejeitado, documento reaberto e muito mais, em tempo real.

Personalize os seus webhooks para assegurar que sua integração possa reagir proativamente à vários eventos executados no TAE.


Considere a seguinte jornada de uma integração: A escola envia um contrato para um aluno, e somente após a finalização desse documento com as assinaturas solicitadas, poderá dar seguimento na matrícula e nos demais processos da escola.


1- Cenário sem webhook:

   I- O sistema da escola gera o documento de matrícula e envia para o aluno.
   II - De tempo em tempo o sistema da escola consulta do status do documento no TAE para saber se o documento já foi assinado. 
        obs: A consulta é unitária, então se enviar 1000 matrículas, e estiver conferindo o status de 2 em 2 minutos, o sistema integrador realizaria 1000 requisições a cada dois minutos nas apis do TAE para conferir se o status do documento mudou.
   III - Quando o status do documento mudar o sistema seguiria com os processos da escola.


2- Cenário com webhook:

  I- O administrador da empresa indica que gostaria de receber notificações de callback (webhook) para documentos finalizados.

  II- O sistema da escola gera o documento de matrícula e envia para o aluno.

  III - Quando o documento for finalizado, o TAE envia uma notificação para o sistema integrador informando que aquele documento foi finalizado e o sistema segue com seus processos da escola.


Vantagens de utilizar o webhook

 * Receber notificações os eventos que escolher

 * Receber notificações em tempo real

 * Remove a necessidade de realizar um processamento em loop, prejudicial a ambos os sistema.

 * Obtem informações detalhadas e personalizadas sobre cada notificação

 * Possibilita receber notificações para todos os documentos ou apenas documentos específicos

 * Interface amigável para gerir webhooks, configurando quais eventos deseja ser notificado


Para criar os webhooks para os eventos que deseja que seu sistema seja notificado, basta acessar o TAE com um usuário administrador da empresa, clicar no menu Integrações → Webhook → Criar webhook.


Após cadastrado ele será exibido na lista de webhooks


É importante só manter webhooks ativos se a URL do sistema integrador já estiver online e apta a receber as notificações conforme foi o webhook foi configurado.

Webhooks ativos vão ser executados para todos os documentos da empresa, sempre que o evento definido ocorrer.


Exemplo: No caso acima, todos os documentos da empresa quando finalizados irão realizar uma requisição POST para a URL configurada no webhook informando o id do documento e o status.



Caso só queira notificar documentos específicos, o webhook deve ser setado como status INATIVO, e os passos do guia abaixo devem ser seguidos.









Os processos listados a seguir somente poderão ser acessados por usuários que são 'Administradores' na plataforma.








Características da jornada: A integração não precisa implementar os recursos de visualizar e assinar o documento. O assinante acessará o documento pelo próprio portal do TAE e fará a assinatura.

https://excalidraw.com/#json=osSYZga9irrgR9cmcyFjw,PngksyWNw09SgiwGqAzJGg

Características da jornada: Uso da autenticação por envio de token por e-mail (sem cadastro de usuário)

https://excalidraw.com/#json=Hbn_rAGadqVK0Le3QQ5z6,_YZ1VBwV7UIoJRR2ywhauA