▸ API · Referência
Todos os endpoints
Os oito endpoints, com método, caminho e escopo — e as convenções que valem pra todos.
atualizado em 2 set 2026versão v1
Base URL https://api.guarita.dev/v1/public. Toda rota exige a chave no header Authorization: Bearer e o escopo indicado. O contrato inteiro também está em OpenAPI 3.1.
Endpoints
| 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 |
Convenções
| Formato | JSON em UTF-8. Requisições com corpo levam Content-Type: application/json. |
| Datas | ISO 8601 em UTC: 2026-08-27T14:09:24.106Z. |
| Nomes de campo | snake_case. Duas exceções: summary (em GET /scans/{id}) e o relatório inteiro são o formato do scanner — camelCase na estrutura, snake_case dentro de ai. Entregamos o documento como ele é, pra API e painel nunca divergirem. |
| Ids | scan_… ronda · key_… chave · acc_… conta · evt_… evento de webhook · dlv_… entrega. |
| Erros | Sempre { error, message } + extras. Catálogo. |
| Rastreio | Toda resposta traz x-request-id. Cite no suporte. |
| CORS | Só a origem do painel. A API é servidor-para-servidor: do navegador, não responde. |
| Versão | /v1. O que muda e o que não muda: Versionamento. |
Só o que faz sentido automatizar entra aqui. Cobrança, time, dados fiscais e exclusão de conta seguem exigindo uma sessão de verdade no painel, com senha e 2FA — chave vazada não pode virar dano irreversível.
Achou algo errado ou faltando? help@guarita.dev — com o
x-request-id, se for sobre uma resposta.