▸ API · Recursos
Changelog
Toda mudança no contrato, com data.
atualizado em 2 set 2026versão v1
Toda mudança no contrato da API entra aqui, com a data — campo novo, evento novo, código de erro novo, correção de comportamento. Mudanças incompatíveis também chegam por e-mail ao dono da conta, com antecedência (veja a política).
- 2026-09-02
POST /scans com todas as opções da ronda, cancelar, PDF e progresso
POST /scansaceita as opções da tela:authenticated,aggressive(comauthorized_intrusive),lgpd,infraeinfra_scope— com os mesmos gates de plano e de verificação do app. As opções da ronda.- Novo
POST /scans/{id}/cancel: cancela uma ronda em andamento e libera a reserva de cota de IA. Idempotente. - Novo
GET /scans/{id}/report.pdf: o mesmo PDF do “Salvar PDF” do painel, com a marca da conta no Business. GET /scans/{id}ganhouprogress(fase, feito/total, módulo da vez) enquanto a ronda roda;nullfora disso.- A declaração de autorização passou pra criação da chave com
scans:write.authorizedno corpo dePOST /scansdeixou de existir: quem ainda manda o campo não quebra — ele é ignorado. A declaração. - Códigos novos:
403 feature_locked(recurso fora do plano; trazfeatureeupgradeTo) e400 intrusive_unauthorized(agressivo sem a confirmação por ronda).
- 2026-09-02
Documentação nova, OpenAPI e x-request-id
- Documentação reescrita, com a referência gerada de uma spec única — a mesma que gera o OpenAPI.
- /docs/api/openapi.json: o contrato em OpenAPI 3.1, incluindo os webhooks.
- /docs/api/llms.txt: a doc inteira em texto, pra colar no contexto da sua IA.
- Toda resposta da API passa a trazer o header
x-request-id— cite-o ao falar com o suporte. - Nenhuma mudança de contrato nos endpoints.
- 2026-08-30
Revogar e remover sem depender do plano
- Revogar uma chave e remover um destino de webhook passam a funcionar em qualquer plano — reduzir acesso nunca exige assinatura.
- E-mail ao dono da conta quando um destino de webhook para de responder, uma vez por sequência de falhas.
- 2026-08-29
Lançamento da API pública v1
- Seis endpoints sob
/v1/public: conta, apps, histórico, disparo, estado e relatório de rondas. - Chaves
gsk_com escoposscans:read,scans:writeeapps:read. - Webhooks de saída assinados, com três eventos:
scan.completed,scan.failedefinding.opened.
- Seis endpoints sob
Achou algo errado ou faltando? help@guarita.dev — com o
x-request-id, se for sobre uma resposta.