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 | Sim | - |
| culture | Tipo de cultura agrícola | String (Enum) | Sim | Valores permitidos: SOY, CORN, SUGAR_CANE, RICE, COTTON, COFFEE, CITRUS, PALM |
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/city?cityCode=5208707&culture=SOY"
Parâmetros
Parâmetros de Query:
| Nome | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| cityCode | Código IBGE da cidade | String | Sim |
| culture | Tipo de cultura agrícola. Valores: SOY, CORN, SUGAR_CANE, RICE, COTTON, COFFEE, CITRUS, PALM | String (Enum) | Sim |
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 |
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 ou ton/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
{
"timestamp": "string (date-time)",
"status": 400,
"error": "string"
}
- 401 - Unauthorized