Ir para o conteúdo

Produtividade

Domínio responsável pela ingestão de dados de produtividade agrícola: TCH, ATR, safra, talhão, variedade e indicadores de qualidade da cana.

Endpoint

POST /v1/integrations/{partnerId}/produtividade

Parâmetro Tipo Descrição
partnerId path client_id OAuth2 do parceiro — deve coincidir com o token

Autenticação: Authorization: Bearer {token} com role productivity.write

Payload

O body aceita três formatos equivalentes:

[
  {
    "idUsina": 1,
    "cdSafra": "2024/2025",
    "cdSetor": "A",
    "cdBloco": "B01",
    "cdFazenda": "FAZ001",
    "idTalhao": 42,
    "dsFazenda": "Fazenda São João",
    "nrAreaTalhao": 15.5,
    "nrAreaColheita": 14.8,
    "cdVariedade": "RB867515",
    "cdAmbiente": "P",
    "cdEspacamento": "1.5",
    "cdTipoCorte": "M",
    "cdTipoColheita": "INT",
    "cdTipoProp": "PR",
    "cdEstagio": "3C",
    "blBIS": false,
    "nrIdade": 12,
    "nrDistancia": 25.3,
    "blReforma": false,
    "dtDataRealizado": "2025-03-15",
    "nrTCHRealizado": 85.4,
    "nrATR": 148.2,
    "nrFibraCana": 12.5,
    "nrPOLCana": 14.1,
    "nrPOLCaldo": 17.8,
    "nrBrixCaldo": 19.2,
    "nrARCaldo": 1.3,
    "cdColheitaPlan": "CP001"
  }
]

{
  "data": [
    {
      "idUsina": 1,
      "cdSafra": "2024/2025",
      "cdSetor": "A",
      "cdBloco": "B01",
      "cdFazenda": "FAZ001",
      "idTalhao": 42,
      "dsFazenda": "Fazenda São João",
      "nrAreaTalhao": 15.5,
      "nrAreaColheita": 14.8,
      "cdVariedade": "RB867515",
      "cdAmbiente": "P",
      "cdEspacamento": "1.5",
      "cdTipoCorte": "M",
      "cdTipoColheita": "INT",
      "cdTipoProp": "PR",
      "cdEstagio": "3C",
      "blBIS": false,
      "nrIdade": 12,
      "nrDistancia": 25.3,
      "blReforma": false,
      "dtDataRealizado": "2025-03-15",
      "nrTCHRealizado": 85.4,
      "nrATR": 148.2,
      "nrFibraCana": 12.5,
      "nrPOLCana": 14.1,
      "nrPOLCaldo": 17.8,
      "nrBrixCaldo": 19.2,
      "nrARCaldo": 1.3,
      "cdColheitaPlan": "CP001"
    }
  ],
  "metadata": {
    "source": "ERP-TOTVS",
    "version": "2.1"
  }
}

{
  "idUsina": 1,
  "cdSafra": "2024/2025",
  "cdSetor": "A",
  "cdBloco": "B01",
  "cdFazenda": "FAZ001",
  "idTalhao": 42,
  "dsFazenda": "Fazenda São João",
  "nrAreaTalhao": 15.5,
  "nrAreaColheita": 14.8,
  "cdVariedade": "RB867515",
  "cdAmbiente": "P",
  "cdEspacamento": "1.5",
  "cdTipoCorte": "M",
  "cdTipoColheita": "INT",
  "cdTipoProp": "PR",
  "cdEstagio": "3C",
  "blBIS": false,
  "nrIdade": 12,
  "nrDistancia": 25.3,
  "blReforma": false,
  "dtDataRealizado": "2025-03-15",
  "nrTCHRealizado": 85.4,
  "nrATR": 148.2,
  "nrFibraCana": 12.5,
  "nrPOLCana": 14.1,
  "nrPOLCaldo": 17.8,
  "nrBrixCaldo": 19.2,
  "nrARCaldo": 1.3,
  "cdColheitaPlan": "CP001"
}

Campos

Obrigatórios

Campo Tipo Descrição
idUsina number Identificador da Usina
cdSafra string Código da Safra (ex: "2024/2025")
cdSetor string Código do Setor
cdBloco string Código do Bloco
cdFazenda string Código da Fazenda
idTalhao number Identificador do Talhão
dsFazenda string Descrição/nome da Fazenda
nrAreaTalhao number ≥ 0 Área do Talhão (ha)
nrAreaColheita number ≥ 0 Área de Colheita (ha)
cdVariedade string Código da Variedade (ex: "RB867515")
cdAmbiente string Código do Ambiente de Produção
cdEspacamento string Código do Espaçamento
cdTipoCorte string Código do Tipo de Corte
cdTipoColheita string Código do Tipo de Colheita
cdTipoProp string Código do Tipo de Propriedade
cdEstagio string Código do Estágio da Cana
blBIS boolean Indica se possui BIS
nrIdade number ≥ 0 Idade da Cana (meses)
nrDistancia number ≥ 0 Distância (metros)
blReforma boolean Indica se houve reforma
dtDataRealizado string Data realizada — formato ISO 8601 (YYYY-MM-DD)
nrTCHRealizado number ≥ 0 TCH Realizado (t/ha)
nrATR number ≥ 0 ATR — Açúcares Totais Recuperáveis (kg/t)
nrFibraCana number 0–100 Fibra de Cana (%)
nrPOLCana number 0–100 Sacarose da Cana (%)
nrPOLCaldo number 0–100 Sacarose do Caldo (%)
nrBrixCaldo number 0–100 Brix do Caldo (%)
nrARCaldo number 0–100 AR do Caldo (%)
cdColheitaPlan string Código da Colheita Planejada

Opcionais (nullable)

Campo Tipo Descrição
nrImpMineral number \| null Número de Insumo Mineral
nrImpVegetal number \| null Número de Insumo Vegetal
nrHorasQueima number \| null Horas de Queima
cdSoloUs string \| null Classificação do tipo de solo
nrCad integer \| null Código cadastral associado ao talhão
dtDataAnterior string \| null Data anterior — ISO 8601
nrTCHAnterior number \| null TCH anterior (t/ha)
nrTCHEstimado number \| null TCH estimado (t/ha)

Resposta

{
  "message": "Productivity data ingested successfully",
  "blobPath": [
    "raw/hub/produtividade/1/2025-03-15/produtividade_1_20250315143022100.json"
  ],
  "fileNames": [
    "produtividade_1_20250315143022100.json"
  ],
  "recordsProcessed": 1
}

{
  "code": "VALIDATION_ERROR",
  "message": "Record 1: Missing required field: cdSafra"
}

{
  "statusCode": 401,
  "message": "Token inválido ou expirado."
}

{
  "error": "Forbidden",
  "message": "O partnerId na URL não corresponde ao cliente autenticado."
}

Exemplo curl completo

curl -X POST \
  "https://api.ctc.com.br/v1/integrations/{partnerId}/produtividade" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -H "X-Correlation-Id: 550e8400-e29b-41d4-a716-446655440000" \
  -d '[
    {
      "idUsina": 1,
      "cdSafra": "2024/2025",
      "cdSetor": "A",
      "cdBloco": "B01",
      "cdFazenda": "FAZ001",
      "idTalhao": 42,
      "dsFazenda": "Fazenda São João",
      "nrAreaTalhao": 15.5,
      "nrAreaColheita": 14.8,
      "cdVariedade": "RB867515",
      "cdAmbiente": "P",
      "cdEspacamento": "1.5",
      "cdTipoCorte": "M",
      "cdTipoColheita": "INT",
      "cdTipoProp": "PR",
      "cdEstagio": "3C",
      "blBIS": false,
      "nrIdade": 12,
      "nrDistancia": 25.3,
      "blReforma": false,
      "dtDataRealizado": "2025-03-15",
      "nrTCHRealizado": 85.4,
      "nrATR": 148.2,
      "nrFibraCana": 12.5,
      "nrPOLCana": 14.1,
      "nrPOLCaldo": 17.8,
      "nrBrixCaldo": 19.2,
      "nrARCaldo": 1.3,
      "cdColheitaPlan": "CP001"
    }
  ]'

Referência OpenAPI

src: ../schemas/productivity.json