> ## 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.

# Changelog

> O que mudou na API, versão a versão.

Mudanças no contrato da API `v1`. Campos novos podem aparecer a qualquer momento (seu código deve ignorar o que não conhece); uma mudança incompatível sairia como `v2`.

**Outubro de 2026**

v1

**Endereço de produção:** a API responde em `https://needalert.app/api/v1`. O `servers` do OpenAPI e os exemplos dos guias usam esse endereço; não há subdomínio `api.`.

**Itens:** no filtro da listagem, `external_reference` vazio ou `null` é ignorado, em vez de responder 422.

**Disparos:** a descrição do **429** em `POST …/items/{item}/events` explica que o limite de disparos conta toda tentativa na rota, inclusive as recusadas com 404, 403 ou 422, e que os headers `X-RateLimit-*` mostram o orçamento com menos requisições restantes.

**Créditos:** a `description` de cada linha do extrato vem no idioma da requisição para as linhas escritas pela plataforma; um ajuste manual mantém o texto em que foi escrito.

**Outubro de 2026**

v1

**Primeira publicação da API pública**, com chaves de API criadas no painel (tela **Integrações**) e autenticação por `Authorization: Bearer`.

**Unidades:** listar e consultar as unidades da chave.

**Itens:** listar (com filtro exato por `external_reference`), criar, consultar, editar, arquivar, enviar e remover a foto, obter o QR Code.

**Disparos:** estimar o custo, disparar ou agendar, listar, consultar, reagendar e cancelar.

**Créditos:** saldo e extrato da rede.

**Para máquinas:** `Idempotency-Key` em `POST …/items` e `POST …/items/{item}/events` (24 horas), `Accept-Language` com o idioma padrão da rede como padrão, `X-Request-Id`, limites de 300 requisições e 60 disparos por minuto por chave.


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