Status ESG das Propriedades (paginado)

Descrição: Percorre, de forma paginada, todas as propriedades da base da cooperativa, devolvendo para cada uma o produtor a que pertence, o status de conformidade socioambiental e as camadas em que ela está embargada, com a quantidade de apontamentos por camada.

É o endpoint para varrer a base inteira. Para consultar uma propriedade específica com o detalhamento de cada apontamento, use a Busca Simplificada.

Endpoint

POST/api/v1/integration/environmental-embargoes/property-status

Regras

Os filtros vão no corpo da requisição. Todos são opcionais — um corpo vazio ({}) devolve a base completa da cooperativa.

Atributos	Descrição	Tipo	Obrigatório	Validações
cod_imovel	Filtra por um código de CAR	String	Não	-
producer_document	Filtra pelo CPF/CNPJ do produtor dono. Pontuação e zeros à esquerda são irrelevantes	String	Não	-
search_param	Busca textual sobre nome da fazenda, CAR, e nome e documento do produtor	String	Não	-
layers	Define o escopo de camadas na mão, sem aplicar o template da cooperativa	List\<String>	Não	Cada camada precisa existir e ser do tipo PROPERTY_ISSUE
use_template	Respeitar o template ESG cadastrado para a cooperativa. Omitido equivale a true	Boolean	Não	true junto de layers preenchido → 400

Escopo de camadas

layers e use_template respondem à mesma pergunta — quais camadas entram na conta — e por isso não podem ser combinados quando use_template é true. As combinações válidas:

use_template	layers	Escopo considerado
omitido	vazio	Template ESG da cooperativa (padrão)
true	vazio	Template ESG da cooperativa
omitido	["EMBARGOS_IBAMA"]	Apenas as camadas informadas, sem template
false	["EMBARGOS_IBAMA"]	Apenas as camadas informadas, sem template
false	vazio	Todas as camadas do tipo PROPERTY_ISSUE
true	["EMBARGOS_IBAMA"]	400 — combinação contraditória

Uma camada inexistente, com o nome errado, ou de tipo incompatível com o endpoint também retorna 400: sem isso a consulta não casaria com nada e devolveria a base inteira como CONFORME.

Os valores válidos saem de Camadas Disponíveis para o Filtro.

Exemplo de Requisição

cURL

curl -X POST \
  -H "Authorization: {SUA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{ "layers": ["EMBARGOS_IBAMA"] }' \
  "https://api.merx.tech/api/v1/integration/environmental-embargoes/property-status?page=0&size=10"

Java

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

String body = "{\"layers\":[\"EMBARGOS_IBAMA\"]}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/environmental-embargoes/property-status?page=0&size=10"))
    .header("Authorization", "{SUA_API_KEY}")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .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 response = await fetch(
  'https://api.merx.tech/api/v1/integration/environmental-embargoes/property-status?page=0&size=10',
  {
    method: 'POST',
    headers: {
      'Authorization': '{SUA_API_KEY}',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ layers: ['EMBARGOS_IBAMA'] }),
  }
);
const data = await response.json();
console.log(data);

Python

import requests

url = "https://api.merx.tech/api/v1/integration/environmental-embargoes/property-status"

headers = {
    "Authorization": "{SUA_API_KEY}",
    "Content-Type": "application/json",
}

params = {"page": 0, "size": 10}
body = {"layers": ["EMBARGOS_IBAMA"]}

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

Parâmetros

Parâmetros de Cabeçalho

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

Parâmetros de Query

Nome	Descrição	Tipo	Obrigatório	Padrão
page	Número da página, começando em zero	Number	Não	0
size	Quantidade de registros por página. Máximo 100	Number	Não	20

Dicionário de dados

Nome	Descrição	Tipo
content	Propriedades da página	Array
content[].cod_imovel	Código do CAR da propriedade. Vem null quando a fazenda não tem CAR	String
content[].producer_name	Nome do produtor a que a propriedade pertence	String
content[].producer_document	CPF ou CNPJ do produtor a que a propriedade pertence	String
content[].status_esg	Status consolidado. Valores: CONFORME, NAO_CONFORME, NAO_ENCONTRADO	Enum
content[].embargoed_layers	Somente as camadas com apontamento. Vazio quando a propriedade está conforme	Array
content[].embargoed_layers[].layer	Camada de análise em que a propriedade está embargada	String
content[].embargoed_layers[].amount	Quantidade de apontamentos naquela camada	Number
total_elements	Total de propriedades que atendem aos filtros	Number
total_pages	Total de páginas	Number
number	Número da página atual, começando em zero	Number
size	Tamanho da página	Number
first	Indica se é a primeira página	Boolean
last	Indica se é a última página	Boolean
number_of_elements	Quantidade de registros nesta página	Number

status_esg é NAO_CONFORME quando embargoed_layers não está vazio e CONFORME quando está. O valor NAO_ENCONTRADO aparece quando a fazenda não tem CAR cadastrado: sem CAR não há chave para cruzar com as bases de embargo, e devolver CONFORME afirmaria uma conformidade que nunca foi verificada. Essas fazendas continuam na listagem, para que a contagem feche com a base da cooperativa.

Respostas

• 200 - Ok

{
  "content": [
    {
      "cod_imovel": "DF-5300108-DEC0BAB9F46848BD9418CF021F92140D",
      "producer_name": "JOSE",
      "producer_document": "34343434",
      "status_esg": "NAO_CONFORME",
      "embargoed_layers": [
        { "layer": "EMBARGOS_IBAMA", "amount": 2 },
        { "layer": "INFRACOES_GO", "amount": 1 }
      ]
    },
    {
      "cod_imovel": "GO-5205471-259F69B1E6EF45B2801214FC18A1E0A7",
      "producer_name": "JOSE",
      "producer_document": "34343434",
      "status_esg": "CONFORME",
      "embargoed_layers": []
    }
  ],
  "total_elements": 3114,
  "total_pages": 312,
  "number": 0,
  "size": 10,
  "first": true,
  "last": false,
  "number_of_elements": 10
}

• 400 - Bad Request

{
  "messages": ["message.layers-or-use-template.exclusive"]
}

Principais mensagens: message.layers-or-use-template.exclusive (use_template: true junto de layers preenchido), message.layers.unknown (camada inexistente ou de outro tipo), message.layers.invalid (entrada vazia em layers), message.size.max-exceeded (size acima de 100), message.size.invalid, message.page.invalid.

• 401 - Unauthorized