API REST
O ION Guard disponibiliza uma API REST completa para integração com sistemas externos, automações e desenvolvimento de aplicações customizadas.
Referência de Endpoints
A documentação interativa e auto-gerada dos endpoints está disponível em:
https://<seu-servidor>/docs/api
A referência é gerada automaticamente a partir do código-fonte via Scramble, garantindo que esteja sempre atualizada com a versão instalada.
Visão geral
| Aspecto | Detalhe |
|---|---|
| Base URL | /api/v1 |
| Autenticação | Bearer Token (Laravel Sanctum) |
| Formato | JSON |
| Paginação | Cursor-based (parâmetro limit, padrão 20, máximo 100) |
| Rate Limiting | 60 req/min (usuário), 5 req/min (auth) |
| Validade do token | 24 horas (1440 min), configurável via SANCTUM_TOKEN_EXPIRATION |
| Versionamento | Via prefixo de URL (/v1/) |
Recursos disponíveis
- Tenants — Gestão de organizações
- Sites — CRUD de localidades
- Zonas — Gestão de zonas dentro de sites
- Alertas — Listagem, detalhes, acknowledge e resolve
- Eventos — Histórico de eventos do domínio
- Usuários — Gestão de usuários e permissões
- Dashboard — Resumo de métricas por site
- Logs de Auditoria — Histórico de alterações
- Health Check —
GET /api/v1/health(sem autenticação)
Guias
- Autenticação — Como obter e usar tokens de acesso
- Paginação — Navegação cursor-based em listas
- Rate Limiting — Limites de requisição por tier
- Erros — Formato de respostas de erro