API Reference
A FastAPI gera documentação interativa automaticamente:
api.viacorretor.com.br/docs — Swagger UI completo com todos os endpoints, schemas de request/response e possibilidade de testar ao vivo.
Localmente: http://localhost:8000/docs
Endpoints por domínio
Autenticação
| Método |
Rota |
Descrição |
| POST |
/v1/auth/magic-link |
Envia magic link por email |
| POST |
/v1/auth/dev-login |
Login sem email (só com DEV_LOGIN=true) |
| GET |
/v1/auth/verify |
Verifica token e retorna JWT |
| POST |
/v1/auth/logout |
Invalida sessão |
| GET |
/v1/me |
Perfil do corretor autenticado |
| PATCH |
/v1/me |
Atualiza perfil |
Imóveis
| Método |
Rota |
Descrição |
| GET |
/v1/properties |
Listagem com filtros (tipo, propósito, quartos, preço, busca) |
| GET |
/v1/properties/featured |
Imóveis em destaque |
| GET |
/v1/properties/{slug} |
Detalhe do imóvel |
Corretores
| Método |
Rota |
Descrição |
| GET |
/v1/brokers/{slug} |
Dados públicos do corretor |
Leads
| Método |
Rota |
Descrição |
| POST |
/v1/leads |
Captura de lead |
| GET |
/v1/leads |
Lista leads (requer auth) |
Admin
| Método |
Rota |
Descrição |
| GET |
/v1/admin/brokers |
Lista todos os corretores |
| POST |
/v1/admin/brokers |
Cria corretor |
| GET |
/v1/admin/brokers/{id} |
Detalhe do corretor |
| PATCH |
/v1/admin/brokers/{id} |
Atualiza corretor |
| POST |
/v1/admin/brokers/{id}/properties |
Vincula imóvel ao corretor |
Analytics
| Método |
Rota |
Descrição |
| POST |
/v1/analytics/page-view |
Registra page view por corretor |
Autenticação na API
Endpoints protegidos esperam o cookie galgal_token (JWT HttpOnly). Para testar via curl:
# 1. Obtenha um token via dev-login
TOKEN=$(curl -s -X POST http://localhost:8000/v1/auth/dev-login \
-H "Content-Type: application/json" \
-d '{"email": "glauci@viacorretor.com.br"}' | jq -r .access_token)
# 2. Use o token no header Authorization
curl http://localhost:8000/v1/me \
-H "Authorization: Bearer $TOKEN"