Referência da API¶
O VIG-IA expõe uma API REST completa via FastAPI com 45+ endpoints.
Base URL¶
Autenticação¶
Todos os endpoints (exceto /auth/login e /health) requerem um token JWT no header:
Endpoints marcados com (ADMIN) requerem perfil admin.
Documentação Interativa¶
O FastAPI gera documentação interativa automaticamente:
- Swagger UI:
http://seu-servidor:5000/docs - ReDoc:
http://seu-servidor:5000/redoc
Teste direto
No Swagger UI, você pode testar os endpoints diretamente no navegador. Primeiro faça login via /api/auth/login e depois clique em "Authorize" para adicionar o token.
Filtros Comuns¶
A maioria dos endpoints de dashboard aceita os seguintes parâmetros:
| Parâmetro | Tipo | Descrição |
|---|---|---|
days |
int | Período relativo (7, 30, 90 dias) |
date_start |
string | Início do período (formato YYYY-MM-DDTHH:MM:SS, hora local) |
date_end |
string | Fim do período |
estabelecimentos |
string | CSV de nomes de unidades |
cenario_id |
int | ID do cenário de monitoramento |
estado_paciente |
string | Estado do paciente (em_atendimento, internado, alta, etc.) |