Visão geral
O que a API cobre, a URL base, os planos e por onde começar.
Dispare uma ronda no fim do deploy, leia o relatório no CI, falhe o build quando aparecer um crítico, receba um aviso assinado quando uma brecha nova surgir. Tudo a partir das suas ferramentas, com uma chave própria — nunca com a sessão do painel.
O primeiro request
Base URL https://api.guarita.dev/v1/public. Crie a chave em Configurações → Desenvolvedores, guarde em GUARITA_API_KEY e confirme que ela funciona:
curl https://api.guarita.dev/v1/public/me \
-H "Authorization: Bearer $GUARITA_API_KEY"{
"account_id": "acc_9f2c1b7e",
"key_id": "key_3a8d41c6",
"scopes": [
"scans:read",
"scans:write",
"apps:read"
],
"plan": "pro"
}Deu 200? O resto é escolher os endpoints. Deu 401? Confira a variável, o estado da chave e o plano — nunca repita um 401.
O que a API cobre
Oito endpoints. Só o que faz sentido automatizar: listar apps, listar rondas, disparar, acompanhar e cancelar uma ronda, ler o relatório em JSON ou em PDF. Cobrança, time, dados fiscais e exclusão de conta ficam de fora — chave vazada não pode virar dano irreversível.
| Endpoint | O que faz | Escopo |
|---|---|---|
GET/me | Confirma que a chave funciona | scans:read |
GET/apps | Lista os apps monitorados | apps:read |
GET/scans | Histórico de rondas | scans:read |
POST/scans | Dispara uma ronda | scans:write |
GET/scans/{id} | Estado e resumo de uma ronda | scans:read |
POST/scans/{id}/cancel | Cancela uma ronda em andamento | scans:write |
GET/scans/{id}/report | Relatório completo de uma ronda | scans:read |
GET/scans/{id}/report.pdf | Relatório de uma ronda em PDF | scans:read |
E três webhooks de saída — scan.completed, scan.failed e finding.opened — pra quem prefere ser avisado a perguntar. Ver os eventos.
Planos
A API pública e os webhooks fazem parte dos planos Pro e Business (a partir de R$ 397/mês). O plano é verificado em toda requisição: se a conta cair pra um plano sem API, as chaves param de autenticar no mesmo instante — e voltam sozinhas quando o plano volta. Nada é apagado.
| Pro | Business | |
|---|---|---|
| Análises com IA por mês | 20 | 60 |
| Apps | 10 | sem limite |
| Histórico de rondas | 365 dias | sem limite |
| Chaves de API ativas | 10 | 10 |
| Destinos de webhook | 5 | 5 |
Por onde seguir
- Comece em 5 minutos— do zero ao primeiro relatório lido pelo CI.
- Referência— cada endpoint com parâmetros, exemplos e erros.
- GitHub Actions— a receita pronta de ronda a cada deploy.
- Erros— o catálogo completo e o que fazer em cada um.
x-request-id, se for sobre uma resposta.