Skip to main content

Documentação da API

A API da Ekonavi fornece acesso programático a todas as funcionalidades da plataforma, permitindo integrações personalizadas e desenvolvimento de aplicações terceirizadas.

Endpoint Base​

https://api.ekonavi.com

Autenticação​

A API utiliza autenticação JWT (JSON Web Tokens). Todas as requisições autenticadas devem incluir o token no header:

Authorization: Bearer <seu-jwt-token>

Obtendo um Token​

POST /api/auth/login-email-password
Content-Type: application/json

{
  "email": "usuario@exemplo.com",
  "password": "senha123"
}

Resposta de Autenticação​

{
  "success": true,
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "user": {
    "id": "12345",
    "email": "usuario@exemplo.com",
    "role": "farmer"
  }
}

Endpoints Principais​

Agricultores​

  • GET /api/farmers - Lista agricultores
  • POST /api/farmers - Criar novo agricultor
  • GET /api/farmers/{id} - Detalhes de um agricultor
  • PUT /api/farmers/{id} - Atualizar agricultor
  • DELETE /api/farmers/{id} - Remover agricultor

Práticas Sustentáveis​

  • GET /api/practices - Lista práticas
  • POST /api/practices - Registrar nova prática
  • GET /api/practices/{id} - Detalhes de uma prática
  • PUT /api/practices/{id} - Atualizar prática

Verificações​

  • GET /api/verifications - Lista verificações
  • POST /api/verifications - Iniciar verificação
  • PUT /api/verifications/{id} - Atualizar status da verificação

Dados Públicos​

  • GET /api/public/stats - Estatísticas gerais
  • GET /api/public/leaderboard - Ranking de agricultores

Swagger UI​

Para uma documentação interativa completa com possibilidade de testar os endpoints, acesse:

https://api.ekonavi.comdocs/swagger

Rate Limiting​

A API possui limites de taxa para evitar abuso:

  • Usuários autenticados: 1000 requisições por hora
  • Usuários não autenticados: 100 requisições por hora

Códigos de Status HTTP​

  • 200 - Sucesso
  • 201 - Criado com sucesso
  • 400 - Requisição inválida
  • 401 - Não autorizado
  • 403 - Proibido
  • 404 - Não encontrado
  • 429 - Limite de taxa excedido
  • 500 - Erro interno do servidor

Próximos Passos​