Buscar Produtividade por Cidade

Descrição: Busca dados de produtividade agrícola filtrados por código da cidade e cultura.

Endpoint

GET/api/v1/integration/productivity/city

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
cityCode	Código IBGE da cidade	String	Não	-
culture	Tipo de cultura agrícola	String (Enum)	Não	Valores permitidos: SOY, CORN, SUGAR_CANE, RICE, COTTON, COFFEE, CITRUS, PALM

Exemplo de Requisição

cURL

curl -X GET \
  -H "Authorization: {SUA_API_KEY}" \
  "https://api.merx.tech/api/v1/integration/productivity/city?cityCode=5208707&culture=SOY"

Java

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

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/productivity/city?cityCode=5208707&culture=SOY"))
    .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 params = new URLSearchParams({ cityCode: '5208707', culture: 'SOY' });
const response = await fetch(
  `https://api.merx.tech/api/v1/integration/productivity/city?${params}`,
  {
    method: 'GET',
    headers: {
      'Authorization': '{SUA_API_KEY}',
    },
  }
);
const data = await response.json();
console.log(data);

Python

import requests

url = "https://api.merx.tech/api/v1/integration/productivity/city"

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

params = {
    "cityCode": "5208707",
    "culture": "SOY"
}

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

Parâmetros

Parâmetros de Query:

Nome	Descrição	Tipo	Obrigatório
cityCode	Código IBGE da cidade	String	Não
culture	Tipo de cultura agrícola. Valores: SOY, CORN, SUGAR_CANE, RICE, COTTON, COFFEE, CITRUS, PALM	String (Enum)	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

Respostas

• 200 - Ok

[
    {
        "city_code": 5208707,
        "culture": "SOY",
        "year": 2023,
        "productivity": 55.5,
        "removed": false,
        "created_at": "2023-01-15T10:30:00Z",
        "updated_at": "2023-01-15T10:30:00Z"
    }
]

Campos da Resposta

Campo	Tipo	Descrição
city_code	Integer	Código IBGE da cidade
culture	String	Tipo de cultura agrícola
year	Integer	Ano de referência
productivity	Double	Produtividade em kg/ha
removed	Boolean	Indica se o registro foi removido
created_at	DateTime	Data de criação do registro
updated_at	DateTime	Data da última atualização

• 400 - Bad Request

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

• 401 - Unauthorized