WebHooks

Introdução

Roteadores às vezes podem demorar para responder a uma requisição sob algumas condições, como, por exemplo:

• Dispositivo desligado (responderá quando iniciado)
• URL ou senha de Force Connection incorreta
• Ações como reboot ou reset, que levam tempo para ocorrer

Os WebHooks só funcionarão se forem previamente ativados em Clientes API.

Funcionamento

Ao receber uma requisição cadastrada em WebHooks, a API responderá com uma mensagem de confirmação de recebimento, com um número de protocolo que identifica todas as ações relacionadas à requisição.

Número de protocolo

O número de protocolo é um UUID de 32 caracteres, com grupos separados por hífens. Todas as respostas enviadas através de WebHooks e que derivem de uma requisição, terão o mesmo UUID.

Métodos Suportados

• devices/parameters/update/: Update de Parâmetros
• /api/v1/devices/reboot: Reboot de dispositivo

Fluxo de WebHook

graph TD
    A[Cliente API] --> B[Envia requisição]
    B --> C[API processa requisição]
    C --> D[Envia comando ao dispositivo]
    D --> E[Dispositivo executa comando]
    E --> F[Dispositivo envia resposta]
    F --> G[API processa resposta]
    G --> H[API envia resposta ao cliente]
    G --> I[API envia WebHook]
    I --> J[Cliente recebe notificação]

Em caso de timeout (1 hora), será enviado um WebHook de erro, porém a ação ainda pode ser executada no dispositivo.

Glossário

Termo	Significado
Timeout	Tempo esgotado
WebHook	Retorno de chamada web

Considerações Finais

É fundamental ativar os WebHooks corretamente e seguir as práticas de segurança na configuração. A compreensão dos métodos suportados e números de protocolo contribui para uma integração eficiente.

Etiquetas

WebHooks API Integracao Monitoramento Automacao

Leia Também