Esta página fornece documentação completa de todos os endpoints disponíveis na API da Ekonavi.
Swagger UI Interativo
Para a documentação mais atualizada e interativa, acesse nossa interface Swagger:
Swagger UI - API Interactive Documentation
A interface Swagger permite:
- Testar endpoints diretamente no navegador
- Ver esquemas de dados em tempo real
- Executar requisições com autenticação
- Explorar respostas com exemplos
OpenAPI Specification
Baixe a especificação OpenAPI completa:
OpenAPI JSON
Endpoints por Categoria
Autenticação
| Método | Endpoint | Descrição |
|---|
POST | /api/auth/login-email-password | Login com email e senha |
POST | /api/auth/google-login | Iniciar login com Google OAuth |
GET | /api/auth/google-callback | Callback do Google OAuth |
POST | /api/auth/wallet-connect | Conectar carteira Ethereum |
POST | /api/auth/refresh | Renovar token JWT |
POST | /api/auth/logout | Logout e invalidar token |
Agricultores
| Método | Endpoint | Descrição |
|---|
GET | /api/farmers | Listar agricultores |
POST | /api/farmers | Criar novo agricultor |
GET | /api/farmers/{id} | Obter agricultor por ID |
PUT | /api/farmers/{id} | Atualizar agricultor |
DELETE | /api/farmers/{id} | Remover agricultor |
GET | /api/farmers/{id}/practices | Práticas de um agricultor |
GET | /api/farmers/profile | Perfil do agricultor logado |
Práticas Sustentáveis
| Método | Endpoint | Descrição |
|---|
GET | /api/practices | Listar práticas sustentáveis |
POST | /api/practices | Registrar nova prática |
GET | /api/practices/{id} | Obter prática por ID |
PUT | /api/practices/{id} | Atualizar prática |
DELETE | /api/practices/{id} | Remover prática |
GET | /api/practices/types | Tipos de práticas disponíveis |
Verificações
| Método | Endpoint | Descrição |
|---|
GET | /api/verifications | Listar verificações |
POST | /api/verifications | Criar nova verificação |
GET | /api/verifications/{id} | Obter verificação por ID |
PUT | /api/verifications/{id} | Atualizar status da verificação |
POST | /api/verifications/{id}/approve | Aprovar verificação |
POST | /api/verifications/{id}/reject | Rejeitar verificação |
Verificadores
| Método | Endpoint | Descrição |
|---|
GET | /api/verifiers | Listar verificadores |
POST | /api/verifiers | Cadastrar novo verificador |
GET | /api/verifiers/{id} | Obter verificador por ID |
PUT | /api/verifiers/{id} | Atualizar verificador |
GET | /api/verifiers/{id}/certifications | Certificações do verificador |
Tokens e Recompensas
| Método | Endpoint | Descrição |
|---|
GET | /api/tokens/balance/{address} | Saldo de tokens de uma carteira |
POST | /api/tokens/mint | Mintar tokens de recompensa |
GET | /api/tokens/transactions | Histórico de transações |
POST | /api/tokens/transfer | Transferir tokens |
GET | /api/rewards/leaderboard | Ranking de recompensas |
Dados Públicos
| Método | Endpoint | Descrição |
|---|
GET | /api/public/stats | Estatísticas gerais da plataforma |
GET | /api/public/farmers/count | Número total de agricultores |
GET | /api/public/practices/count | Número total de práticas registradas |
GET | /api/public/verifications/count | Número total de verificações |
GET | /api/public/tokens/total-supply | Oferta total de tokens |
GET | /api/public/impact/carbon-offset | Total de carbono compensado |
Administração
| Método | Endpoint | Descrição |
|---|
GET | /api/admin/dashboard | Dashboard administrativo |
GET | /api/admin/users | Listar todos os usuários |
PUT | /api/admin/users/{id}/role | Alterar role de usuário |
GET | /api/admin/system/health | Status de saúde do sistema |
GET | /api/admin/logs | Logs do sistema |
Schemas de Dados
Para informações detalhadas sobre os schemas de request/response, consulte:
Rate Limiting
Todos os endpoints possuem limitação de taxa:
- Usuários autenticados: 1000 req/hora
- Usuários anônimos: 100 req/hora
- Dados públicos: 200 req/hora
Status Codes
| Code | Significado |
|---|
200 | Sucesso |
201 | Criado |
400 | Requisição inválida |
401 | Não autorizado |
403 | Proibido |
404 | Não encontrado |
429 | Limite de taxa excedido |
500 | Erro interno |
Próximos Passos