> ## Documentation Index
> Fetch the complete documentation index at: https://docs.needalert.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Visão geral da API

> Integre o sistema do seu negócio ao Need Alert e dispare alertas automaticamente.

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

> [card] [Estoque voltou](https://docs.needalert.app/api/use-cases.md)
>
> Seu ERP dispara o alerta quando o estoque de um SKU volta a ficar positivo.

> [card] [Horário cancelado](https://docs.needalert.app/api/use-cases.md)
>
> O sistema de agenda da clínica avisa os inscritos na especialidade quando um paciente cancela.

> [card] [Itens sincronizados](https://docs.needalert.app/api/external-reference.md)
>
> Sua loja virtual cria e atualiza itens a partir dos próprios produtos.

> [card] [Saldo sob controle](https://docs.needalert.app/api/use-cases.md)
>
> Seu financeiro acompanha o saldo e o extrato de créditos.

## O que está disponível

* **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](https://docs.needalert.app/api/authentication.md).
* **Itens:** listar, criar, editar e arquivar, com uma [referência externa](https://docs.needalert.app/api/external-reference.md) 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](https://docs.needalert.app/api/first-request.md).
* **Créditos:** consultar saldo e extrato.
* **Idempotência:** o header [`Idempotency-Key`](https://docs.needalert.app/api/idempotency) 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.

## Por onde começar

1. Leia [Autenticação](https://docs.needalert.app/api/authentication.md) e crie a chave no painel.
2. Siga [Primeira requisição](https://docs.needalert.app/api/first-request.md) até o primeiro alerta.
3. Consulte cada endpoint no grupo **Endpoints** desta aba, e as regras gerais em [Convenções](https://docs.needalert.app/api/conventions.md).
4. Acompanhe as mudanças no [Changelog](https://docs.needalert.app/api/changelog.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.