Buscar Produtividade por CAR e Cultura
Descrição: Busca dados de produtividade agrícola filtrados por Cadastro Ambiental Rural (CAR), cultura específica e safra. Permite uma consulta mais direcionada para análise de produtividade.
Endpoint
GET/api/v1/integration/productivity/{car}/cultures/{culture}
Regras
| Atributos | Descrição | Tipo | Obrigatório | Validações |
|---|---|---|---|---|
| car | Cadastro Ambiental Rural | String | Sim | Código CAR válido |
| culture | Tipo de cultura agrícola | String (Enum) | Sim | Valores: SOY, CORN, SUGAR_CANE, RICE, COTTON, COFFEE, CITRUS, PALM |
| harvest | Safra | String | Sim | - |
| 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 |
Exemplo de Requisição
Exemplo de Requisição
curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://homolog.api.merx.tech/api/v1/integration/productivity/MT-5107909-XXXXXXXXXXXXXXXXXXXXXXXX/cultures/SOY?harvest=2022/2023&source=MERX&excludeSmallerAreas=true&includeGeoJson=false"
Parâmetros
Parâmetros de Caminho:
| Nome | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| car | Cadastro Ambiental Rural (CAR) | String | Sim |
| culture | Tipo de cultura agrícola | String (Enum) | Sim |
Parâmetros de Query:
| Nome | Descrição | Tipo | Obrigatório | Padrão |
|---|---|---|---|---|
| harvest | Identificador da safra | String | Sim | - |
| 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 |
Parâmetros de Cabeçalho
| Nome | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| Authorization | Token de autenticação | 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) |
| 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": "{...}" // Apenas se includeGeoJson=true
}
]
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 (ton/ha ou 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 |
| geo_json | String | Geometria em formato GeoJSON (opcional) |
- 400 - Bad Request
{
"timestamp": "string (date-time)",
"status": 400,
"error": "string"
}
- 401 - Unauthorized