Aera+ API

API RESTful para gerenciamento completo de sistemas de aeração em fazendas de camarão

Visão Geral

A API AeraPlus é uma solução completa para automatizar e gerenciar sistemas em fazendas de camarão. Com ela, você pode controlar dispositivos, configurar agendamentos automáticos e monitorar toda a operação em tempo real.

Autenticação JWT

Sistema seguro de autenticação usando JSON Web Tokens com suporte a “lembrar-me”.

Análise Financeira com IA

🆕 Rastreamento de custos, análise de lucratividade e recomendações de colheita otimizadas por IA.

Gerenciamento de Lotes

🆕 Rastreamento completo do ciclo de produção com monitoramento de crescimento e cálculos de biomassa.

Gerenciamento de Viveiros

🆕 Configure e monitore viveiros com especificações detalhadas e rastreamento de qualidade da água.

Gerenciamento de Fazendas

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

Pontos de Controle & Aeradores

Gerencie dispositivos de controle centralizados e equipamentos aeradores para monitoramento e automação.

Agendamentos Automáticos

Configure horários para automação de tarefas no sistema.

Sistema de Alertas

Receba notificações sobre eventos importantes como oxigênio baixo ou falhas.

Logs de Auditoria

Acompanhe todas as ações realizadas no sistema para fins de auditoria.

Recursos da API

Recurso	Descrição	Métodos	Docs
Assinaturas 🆕	Planos multi-nível com integração Stripe	`GET` `PUT` `POST`	→
Dashboard 🆕	Analytics e insights em tempo real	`GET`	→
Notificações 🆕	Alertas em tempo real e notificações de eventos	`GET` `PATCH` `POST`	→
Biometria 🆕	Rastreamento de crescimento e medições	`GET` `POST`	→
Qualidade da Água 🆕	Monitoramento de parâmetros com alertas	`GET` `POST`	→
Alimentação 🆕	Registros de alimentação com cálculos de FCA	`GET` `POST`	→
Financeiro	Análise de custos e otimização com IA	`GET` `POST`	→
Lotes	Gerenciamento do ciclo de produção	`GET` `POST` `PUT` `DELETE`	→
Viveiros	Configuração e monitoramento de viveiros	`GET` `POST` `PUT` `DELETE`	→
Usuários	Gerenciamento de perfis e autenticação	`GET` `POST` `PUT` `DELETE`	→
Fazendas	CRUD de fazendas de camarão	`GET` `POST` `PUT` `DELETE`	→
Aeradores	Controle e monitoramento de aeradores	`GET` `POST` `PUT` `DELETE`	→
Pontos de Controle	Gerenciamento centralizado de dispositivos	`GET` `POST` `PUT` `DELETE`	→
Agendamentos	Automação baseada em tempo	`GET` `POST` `PUT` `DELETE`	→
Alertas	Notificações e avisos do sistema	`GET` `POST` `PUT` `DELETE`	→
Logs	Histórico de atividades	`GET`	→
Endereços	Gerenciamento de localizações	`GET` `POST` `PUT` `DELETE`	→

Especificações Técnicas

Framework

FastAPI — Framework Python moderno e de alta performance

Banco de Dados

PostgreSQL — Banco relacional robusto e escalável

Autenticação

JWT Bearer Token — Tokens seguros com expiração configurável

Versão

v1.3.0 — Atualização de Assinaturas & Analytics

📝 Notas de Atualização - Versão 1.3.0

🆕 Novos Módulos

💳 Sistema de Assinaturas NOVO

Gerenciamento completo de assinaturas com integração Stripe, quatro níveis de planos e controle automático de limites.

Endpoint	Método	Descrição
`/subscriptions/me`	`GET`	Obter assinatura atual do usuário
`/subscriptions/me/limits`	`GET`	NOVO Verificar limites de uso (fazendas, viveiros, lotes)
`/subscriptions/plans`	`GET`	NOVO Listar planos disponíveis (FREE, BASIC, PRO, ENTERPRISE)
`/subscriptions/{user_id}`	`PUT`	Atualizar assinatura (admin)
`/subscriptions/{user_id}/limits`	`GET`	NOVO Consultar limites de outro usuário (admin)
`/stripe/create-checkout-session`	`POST`	Criar sessão de pagamento Stripe
`/stripe/create-billing-portal`	`POST`	NOVO Acessar portal de cobrança do cliente
`/stripe/cancel-subscription`	`POST`	NOVO Cancelar assinatura ativa

Níveis de Plano:

GRATUITO: 1 fazenda, 2 viveiros, 1 lote ativo
BÁSICO: 3 fazendas, 10 viveiros, 5 lotes ativos
PROFISSIONAL: 10 fazendas, 50 viveiros, 25 lotes ativos
EMPRESARIAL: Ilimitado

📊 Dashboard Analytics NOVO

Sistema de dashboard completo com KPIs em tempo real, gráficos e insights de produção.

Endpoint	Método	Descrição
`/dashboard/overview`	`GET`	Estatísticas gerais da fazenda
`/dashboard/ponds`	`GET`	Resumos detalhados de todos os viveiros
`/dashboard/biomass-trend`	`GET`	Tendência histórica de biomassa
`/dashboard/growth-rates`	`GET`	Análise de taxas de crescimento
`/dashboard/survival-rates`	`GET`	Rastreamento de população e sobrevivência
`/dashboard/feed-efficiency`	`GET`	Análise de eficiência alimentar (FCA)

🌐 Dispositivos IoT NOVO

Integração com dispositivos ESP32 para monitoramento em tempo real.

Endpoint	Método	Descrição
`/iot/heartbeat`	`POST`	Registrar heartbeat do dispositivo
`/iot/shadow/{device_id}`	`GET`	Obter shadow state atual
`/iot/shadow/{device_id}`	`PUT`	Atualizar shadow state desejado

📤 Sistema de Exportação NOVO

Exportação de dados em formato CSV para análise externa.

Endpoint	Método	Descrição
`/exports/biometries`	`GET`	Exportar dados de biometria
`/exports/feeding`	`GET`	Exportar registros de alimentação
`/exports/water-quality`	`GET`	Exportar medições de qualidade da água
`/exports/batch-report/{batch_id}`	`GET`	Relatório completo do lote (PDF/CSV)

📦 Transferência de Lotes NOVO

Sistema para transferir lotes entre viveiros com rastreamento de custos.

Endpoint	Método	Descrição
`/batch-transfers/`	`POST`	Criar nova transferência
`/batch-transfers/`	`GET`	Listar todas as transferências
`/batch-transfers/{id}`	`GET`	Detalhes de uma transferência
`/batch-transfers/batch/{batch_id}`	`GET`	Histórico de transferências do lote

🔧 Endpoints Adicionados a Módulos Existentes

📏 Biometria MELHORADO

Endpoint	Método	Status	Descrição
`/biometries/batch/{id}/summary`	`GET`	NOVO	Estatísticas agregadas do lote (peso médio, CV%, crescimento)

💧 Qualidade da Água MELHORADO

Endpoint	Método	Status	Descrição
`/water-quality/latest`	`GET`	NOVO	Últimas leituras de cada viveiro
`/water-quality/alerts`	`GET`	NOVO	Alertas ativos de qualidade da água
`/water-quality/trend/{pond_id}/{parameter}`	`GET`	NOVO	Tendências de parâmetros específicos

🍤 Alimentação MELHORADO

Endpoint	Método	Status	Descrição
`/feeding/batch/{id}/recommendation`	`GET`	NOVO	Recomendações de alimentação por IA

Detalhes da Recomendação:

Quantidade sugerida baseada em biomassa atual
Frequência ideal de alimentação
Ajustes por temperatura da água
Histórico de FCA para otimização

🔔 Notificações MELHORADO

Endpoint	Método	Status	Descrição
`/notifications/unread/count`	`GET`	NOVO	Contador de notificações não lidas (para badges)

📦 Lotes (Produção) MELHORADO

Endpoint	Método	Status	Descrição
`/batches/{id}/growth-analysis`	`GET`	NOVO	Análise completa da curva de crescimento
`/batches/{id}/growth-chart`	`GET`	NOVO	Dados formatados para gráficos

Growth Analysis inclui:

Taxa de crescimento diária (g/dia)
Projeção de peso para colheita
Comparação com curvas de referência
Identificação de anomalias

🏊 Viveiros MELHORADO

Endpoint	Método	Status	Descrição
`/ponds/summary-cards`	`GET`	NOVO	Cards de resumo de todos os viveiros
`/ponds/{pond_id}/summary-card`	`GET`	NOVO	Card de resumo individual

Summary Card inclui:

Status do lote atual
Biomassa estimada
Dias de cultivo
Último registro de qualidade da água
Alertas ativos

⚠️ Alterações em Endpoints Existentes

Assinaturas ALTERADO

Endpoint	Mudança
`GET /subscriptions/me`	ALTERADO Resposta agora inclui `usage_limits`, `features_enabled` e `stripe_customer_id`
`PUT /subscriptions/{user_id}`	ALTERADO Adicionados campos `max_farms`, `max_ponds`, `max_active_batches`

Dashboard ALTERADO

Endpoint	Mudança
`GET /dashboard/feed-efficiency`	ALTERADO Estrutura de resposta reformulada para incluir breakdown por lote

🐛 Correções de Bugs CORRIGIDO

Problema	Status	Descrição
Cálculo de FCA	CORRIGIDO	Precisão melhorada nas recomendações de alimentação
Alertas de Qualidade da Água	CORRIGIDO	Problemas de timezone resolvidos
Curva de Crescimento	CORRIGIDO	Precisão da curva de biometria melhorada
Listagem de Lotes	CORRIGIDO	Paginação corrigida para grandes volumes
Serialização Pydantic	CORRIGIDO	Problemas com Pydantic v2 resolvidos
Comparação de Enum	CORRIGIDO	BatchStatus no controller de alimentação

📚 Nova Documentação

Página	Descrição	Link
Exportações	Sistema completo de exportação CSV	Ver →
Transferência de Lotes	Gerenciamento de transferências	Ver →
Dispositivos IoT	Integração ESP32	Ver →

📊 Resumo da Versão

5 Novos Módulos

Assinaturas, Dashboard, IoT, Exportações e Transferências de Lotes.

15+ Novos Endpoints

Novos endpoints em módulos existentes e novos.

6 Correções

Bugs críticos corrigidos para melhor estabilidade.

3 Novas Docs

Documentação completa para novos módulos.

Comece Agora

Início Rápido

Aprenda a usar a API em 5 minutos.

Começar →

Autenticação

Entenda como autenticar suas requisições.

Ver →

Roadmap

Visão completa do ecossistema: Software + Hardware IoT.

Explorar →

Boas Práticas

Dicas para usar a API de forma eficiente.

Aprender →