Visão Geral

A API Aera+ é uma API RESTful construída com FastAPI que fornece gerenciamento completo de sistemas de aeração para fazendas de camarão. Ela suporta múltiplos usuários, fazendas, viveiros e controle automatizado de aeradores.

Informações Gerais

Propriedade	Valor
Versão	1.3.0
Framework	FastAPI
Banco de Dados	PostgreSQL
Autenticação	JWT (JSON Web Tokens)
Data de Lançamento	19 de Fevereiro de 2026

URL Base

Desenvolvimento

http://localhost:8000/api/v1

Produção

https://your-production-domain.com/api/v1

Formato de Resposta

Resposta de Sucesso

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Example Farm",
  "created_at": "2025-11-21T10:30:00Z"
}

Resposta de Erro

{
  "detail": "Mensagem de erro descrevendo o que deu errado"
}

Principais Recursos

Sistema de Assinaturas 🆕

Sistema multi-nível com integração Stripe, limites automáticos e flags de recursos.

Dashboard Analytics 🆕

Insights em tempo real com visão geral da fazenda, tendências de biomassa, taxas de crescimento e análise de eficiência alimentar.

Sistema de Notificações 🆕

Notificações em tempo real para alertas, eventos do sistema, atualizações de assinatura e confirmações de pagamento.

Gerenciamento Inteligente de Produção

Rastreie lotes com biometria, qualidade da água, registros de alimentação e transferências.

Controle Inteligente de Estoque

Dedução automática de estoque em eventos de alimentação com alertas de baixo estoque.

Análise Financeira com IA

Previsão do momento ideal de despesca considerando taxa de crescimento, preço de mercado e custos operacionais.

Sistema de Exportação 🆕

Exporte relatórios completos em formatos PDF, Excel ou CSV.

Monitoramento de Qualidade de Água

Rastreamento de parâmetros ambientais com alertas automatizados baseados em limites.

Gerenciamento de Fazendas

Crie e gerencie múltiplas fazendas de camarão com informações de localização e endereço.

Automação IoT

Controle dispositivos através de pontos de controle com sistema Shadow State.

Agendamentos

Configure agendamentos automáticos para tarefas do sistema.

Logs de Auditoria

Acompanhe todas as ações realizadas no sistema.

Modos de Ambiente

A API suporta dois modos de ambiente:

Desenvolvimento (`ENVIRONMENT=dev`)

Usa banco de dados PostgreSQL local via Docker
Log de queries SQL habilitado
CORS permite todas as origens (*)
Documentação da API disponível em /api/v1/docs

Produção (`ENVIRONMENT=prod`)

Usa banco de dados configurado na nuvem (ex: Supabase)
Log de queries SQL desabilitado
CORS restrito a domínios específicos
Pool de conexões otimizado

Documentação Interativa

Ao rodar em modo de desenvolvimento, acesse a documentação interativa:

Swagger UI: http://localhost:8000/api/v1/docs
ReDoc: http://localhost:8000/api/v1/redoc

Esquema do Banco de Dados

Entidades Principais:

Users - Usuários do sistema (Admin, Owner, Operator)
Farms - Fazendas de camarão
Ponds - Viveiros dentro das fazendas
Batches - Lotes de produção com rastreamento de biometria
Control Points - Dispositivos IoT que gerenciam múltiplos viveiros
Schedules - Ações automáticas baseadas em tempo
Alerts - Notificações e avisos do sistema
Products - Catálogo de produtos com controle de estoque
OperationalExpenses - Despesas operacionais por categoria
WaterQuality - Monitoramento de parâmetros ambientais
Logs - Trilha de auditoria e atividades
Addresses - Localizações físicas

Próximos Passos

Autenticação

Aprenda como autenticar suas requisições. Ver documentação →

Início Rápido

Comece a usar a API rapidamente. Ver guia → Ver guia →