Para realizar um callback para documentos específicos é necessário criar um webhook seguindo os passos acima, e configurá-lo como "inativo". Assim, ao invés de ser executado para todos os documentos da empresa, ele só será disparado nos documentos que ele for configurado.
Após criar o webhook utilize a API WEBHOOKS do TAE. Necessário autenticar na api com Bearer token do usuário administrador com permissão de Configurações da empresa. (Gerado na rota de login API IDENTITY) - LINK API
Busque pelo Webhook cadastrado anteriormente através da rota Get /v1/subscription - LINK API
Serão listados todos os webhooks cadastrados da sua empresa:
Para gerar um callback personalizado para esse webhook, possíbilitando incluí-lo em documentos específicos, basta copiar o ID do webhook e utilizar a rota POST /v1/callbacks para criar o callback personalizado. - LINK API
Nesse momento é necessário indicar o subscriptionId referente ao webhook "pai" desse callback. Também é possivel definir novos campos para compor o "body" da requisição. Se novos atributos forem enviados, irão sobrescrever os atributos originais do webhook pai. Se nada for enviado no body, os atributos permanecerão conforme configurados no webhook.
É possível consultar os detalhes do webhook também pela API, pela rota GET /v1/subscription/{subscritionId} - LINK API
Seu callback personalizado irá utilizar as configurações do webhook pai, podendo ou não ter ser body personalizado.
No exemplo abaixo, não personalizaremos os atributos do body da requisição, mantendo os que foram definidos no webhook.
Ao executar com sucesso, a api retornará o id desse callback personalizado.
Esse id poderá ser atribuido nos documentos no qual você deseja ser notificado sobre esse evento. A inclusão do callback em uma publicação pode ser feita em qualquer momento após o upload do arquivo, basta ter o id do arquivo e o id do callback.
Utilize a api Sign Integration na rota POST /v1/Publicacoes/{idArquivo}/CallBacks - LINK API
A api retornará sucesso.
Após isso, quando esse documento for finalizado. O TAE irá notificar o webhook relacionado com esse callback indicado.
Callback recebido pela integração:
Obs: Um documento pode ter N callbacks (desde que sejam distintos). Um callback pode estar vinculado a N documentos.
|