Endpoints de Exportação

Visão Geral

A API de Exportação permite baixar dados do sistema em formato CSV para análise em planilhas, sistemas externos ou relatórios offline.

Formatos Suportados

Atualmente, apenas CSV é suportado. Formatos adicionais como Excel (.xlsx) e PDF estão planejados para versões futuras.

---

GET /exports/biometries/csv

Exporta dados de biometria para um lote em formato CSV.

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
batch_id	integer	✅	ID do lote para exportar

Requisição

GET /api/v1/exports/biometries/csv?batch_id=1
Authorization: Bearer {token}

Resposta

Retorna um arquivo CSV com os seguintes campos:

date,sample_weight,sample_count,average_weight,biomass,survival_rate,population
2026-01-15,250.5,50,5.01,1002.0,98.5,200000
2026-01-30,520.0,50,10.4,2028.0,97.8,195000

Campos CSV

Campo	Descrição
date	Data da biometria
sample_weight	Peso total da amostra (g)
sample_count	Número de animais amostrados
average_weight	Peso médio por animal (g)
biomass	Biomassa total estimada (kg)
survival_rate	Taxa de sobrevivência (%)
population	População estimada

---

GET /exports/feeding/csv

Exporta registros de alimentação para um lote em formato CSV.

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
batch_id	integer	✅	ID do lote
start_date	date	❌	Data inicial (YYYY-MM-DD)
end_date	date	❌	Data final (YYYY-MM-DD)

Requisição

GET /api/v1/exports/feeding/csv?batch_id=1&start_date=2026-01-01&end_date=2026-01-31
Authorization: Bearer {token}

Resposta

date,feed_type,quantity_kg,frequency,observations
2026-01-15,ração 40%,150.5,4,normal
2026-01-16,ração 40%,155.0,4,aumento por temperatura

---

GET /exports/water-quality/csv

Exporta dados de qualidade da água para um tanque em formato CSV.

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
pond_id	integer	✅	ID do tanque
start_date	date	❌	Data inicial
end_date	date	❌	Data final

Requisição

GET /api/v1/exports/water-quality/csv?pond_id=1&start_date=2026-01-01&end_date=2026-01-31
Authorization: Bearer {token}

Resposta

date,time,temperature,dissolved_oxygen,ph,ammonia,nitrite,transparency
2026-01-15,06:00,28.5,6.2,7.8,0.1,0.02,35
2026-01-15,14:00,31.2,5.8,8.1,0.15,0.03,32

---

GET /exports/batch/{batch_id}/report/csv

Exporta relatório completo do lote em formato CSV.

Parâmetros de Path

Parâmetro	Tipo	Descrição
batch_id	integer	ID do lote

Requisição

GET /api/v1/exports/batch/1/report/csv
Authorization: Bearer {token}

Resposta

Retorna um arquivo CSV com dados consolidados do lote incluindo:

• Informações do lote
• Resumo de biometrias
• Resumo de alimentação
• Resumo de qualidade da água
• Métricas financeiras

---

GET /exports/batch/{batch_id}/summary

Obtém dados resumidos do lote para exportação.

Parâmetros de Path

Parâmetro	Tipo	Descrição
batch_id	integer	ID do lote

Requisição

GET /api/v1/exports/batch/1/summary
Authorization: Bearer {token}

Resposta 200 OK

{
  "batch_id": 1,
  "batch_name": "Lote 2026-A",
  "species": "Litopenaeus vannamei",
  "start_date": "2026-01-01",
  "end_date": null,
  "status": "active",
  "initial_population": 200000,
  "current_population": 195000,
  "survival_rate": 97.5,
  "total_feed_kg": 4500.5,
  "current_biomass_kg": 2500.0,
  "fcr": 1.8,
  "average_weight_g": 12.8,
  "days_of_culture": 45,
  "cost_per_kg": 15.50
}

---

Melhores Práticas

Usando Filtros de Data

Sempre use filtros start_date e end_date para grandes conjuntos de dados para evitar timeouts e reduzir tamanho do arquivo.

Exemplo de Importação Excel

1. Baixe o arquivo CSV
2. Abra o Excel
3. Use “Dados” → “De Texto/CSV”
4. Selecione UTF-8 como codificação
5. Use vírgula como delimitador

Exemplo de Análise Python

import pandas as pd

# Baixar e analisar biometrias
biometries = pd.read_csv('biometries.csv', parse_dates=['date'])

# Calcular taxa de crescimento
biometries['growth_rate'] = biometries['average_weight'].pct_change()

# Plotar curva de crescimento
biometries.plot(x='date', y='average_weight', kind='line')