Visão geral da API

A API do Need Alert permite que o sistema do seu negócio faça, sem ninguém na frente da tela, o que hoje você faz pelo painel.

Para que serve

Seu ERP dispara o alerta quando o estoque de um SKU volta a ficar positivo.

O sistema de agenda da clínica avisa os inscritos na especialidade quando um paciente cancela.

Sua loja virtual cria e atualiza itens a partir dos próprios produtos.

Seu financeiro acompanha o saldo e o extrato de créditos.

Chaves de API criadas pelo dono da rede no painel, com nome, unidades permitidas e permissões. A chave é exibida uma única vez e pode ser trocada ou revogada a qualquer momento. Veja Autenticação.
Itens: listar, criar, editar e arquivar, com uma referência externa para usar o código do seu sistema (como o SKU), e obter o QR Code.
Disparos: estimar o custo, disparar na hora ou agendar, acompanhar o status, reagendar e cancelar. Veja Primeira requisição.
Créditos: consultar saldo e extrato.
Idempotência: o header Idempotency-Key para que uma nova tentativa após uma falha de rede não dispare o alerta duas vezes.

Todo disparo pela API segue as mesmas regras do painel: o custo é calculado antes, o saldo é conferido e o débito é de 1 crédito por pessoa avisada.

Leia Autenticação e crie a chave no painel.
Siga Primeira requisição até o primeiro alerta.
Consulte cada endpoint no grupo Endpoints desta aba, e as regras gerais em Convenções.
Acompanhe as mudanças no Changelog.