Buscar Produtividade por CAR

Descrição: Busca dados de produtividade agrícola por Cadastro Ambiental Rural (CAR), com opções de filtros por ano, cultura, safra e fonte de dados.

Endpoint

GET/api/v1/integration/productivity/{car}

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
car	Cadastro Ambiental Rural	String	Sim	Código CAR válido
year	Ano de referência	String	Não	-
culture	Tipo de cultura agrícola	String (Enum)	Não	Valores: SOY, CORN, SUGAR_CANE, RICE, COTTON, COFFEE, CITRUS, PALM
source	Fonte dos dados	String (Enum)	Não	Valores: MERX (padrão), MAPBIOMAS
excludeSmallerAreas	Excluir áreas menores	Boolean	Não	Padrão: true
includeGeoJson	Incluir geometria na resposta	Boolean	Não	Padrão: false
harvest	Safra	String	Não	-

Exemplo de Requisição

cURL

curl -X GET \
  -H "Authorization: {SUA_API_KEY}" \
  "https://api.merx.tech/api/v1/integration/productivity/MT-5107909-XXXXXXXXXXXXXXXXXXXXXXXX?year=2023&culture=SOY&source=MERX"

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

String car = "MT-5107909-XXXXXXXXXXXXXXXXXXXXXXXX";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/productivity/" + car + "?year=2023&culture=SOY&source=MERX"))
    .header("Authorization", "{SUA_API_KEY}")
    .GET()
    .build();

HttpClient client = HttpClient.newHttpClient();
try {
    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
} catch (Exception e) {
    e.printStackTrace();
}

JavaScript

const car = 'MT-5107909-XXXXXXXXXXXXXXXXXXXXXXXX';
const params = new URLSearchParams({ year: '2023', culture: 'SOY', source: 'MERX' });
const response = await fetch(
  `https://api.merx.tech/api/v1/integration/productivity/${car}?${params}`,
  {
    method: 'GET',
    headers: {
      'Authorization': '{SUA_API_KEY}',
    },
  }
);
const data = await response.json();
console.log(data);

Python

import requests

car = "MT-5107909-XXXXXXXXXXXXXXXXXXXXXXXX"
url = f"https://api.merx.tech/api/v1/integration/productivity/{car}"

headers = {
    "Authorization": "{SUA_API_KEY}",
}

params = {
    "year": "2023",
    "culture": "SOY",
    "source": "MERX"
}

response = requests.get(url, params=params, headers=headers)
print(response.json())

Parâmetros

Parâmetros de Caminho:

Nome	Descrição	Tipo	Obrigatório
car	Cadastro Ambiental Rural (CAR)	String	Sim

Parâmetros de Query:

Nome	Descrição	Tipo	Obrigatório	Padrão
year	Ano de referência da produtividade	String	Não	-
culture	Tipo de cultura agrícola	String (Enum)	Não	-
source	Fonte dos dados de produtividade	String (Enum)	Não	MERX
excludeSmallerAreas	Excluir áreas menores da análise	Boolean	Não	true
includeGeoJson	Incluir geometria GeoJSON na resposta	Boolean	Não	false
harvest	Identificador da safra	String	Não	-

Parâmetros de Cabeçalho

Nome	Descrição	Tipo	Obrigatório
Authorization	Chave de API obtida via support-api@merx.tech	String	Sim

Culturas Disponíveis

Valor	Descrição
SOY	Soja
CORN	Milho
SUGAR_CANE	Cana-de-açúcar
RICE	Arroz
COTTON	Algodão
COFFEE	Café
CITRUS	Citrus
PALM	Palma

Fontes de Dados

Valor	Descrição
MERX	Dados processados pela plataforma Merx (padrão). Disponíveis apenas culturas Soja e Milho
MAPBIOMAS	Dados do projeto MapBiomas

Respostas

• 200 - Ok

[
  {
    "car": "MT-5107909-XXXXXXXXXXXXXXXXXXXXXXXX",
    "year_area": "2023",
    "year_productivity": "2023",
    "harvest": "2022/2023",
    "product": "SOY",
    "county_productivity": 55.5,
    "planted_area": 150.75,
    "declared_area": 200.0,
    "estimated_total_annual_production": 8366.625,
    "geo_json": null
  }
]

Campos da Resposta

Campo	Tipo	Descrição
car	String	Cadastro Ambiental Rural
year_area	String	Ano de referência da área
year_productivity	String	Ano de referência da produtividade
harvest	String	Identificador da safra
product	String	Tipo de cultura/produto
county_productivity	Double	Produtividade média do município (kg/ha)
planted_area	Double	Área plantada em hectares
declared_area	Double	Área declarada em hectares
estimated_total_annual_production	Double	Produção total anual estimada (ton)
geo_json	String	Geometria em formato GeoJSON (opcional)

• 400 - Bad Request

{
  "messages": ["message.entidade.campo-inválido"]
}

• 401 - Unauthorized