Camadas Disponíveis para o Filtro

Descrição: Lista as camadas de análise que podem ser usadas no filtro layers do Status ESG dos Produtores e do Status ESG das Propriedades. Devolve apenas o valor a enviar e o nome legível da camada.

O campo layer é exatamente o que vai em layers e o que volta em embargoed_layers[].layer — o mesmo identificador nos três lugares.

Endpoint

GET/api/v1/integration/environmental-embargoes/layers

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
type	Escopo das camadas. Omitido, devolve as dos dois escopos	String	Não	PRODUCER_ISSUE ou PROPERTY_ISSUE

Use type=PRODUCER_ISSUE para montar o filtro de /producer-status e type=PROPERTY_ISSUE para o de /property-status. Passar uma camada do escopo errado nesses endpoints retorna 400.

Camadas do tipo INFORMATION nunca são aceitas no filtro e por isso não aparecem nesta lista, mesmo sem type.

Exemplo de Requisição

cURL

curl -X GET \
  -H "Authorization: {SUA_API_KEY}" \
  "https://api.merx.tech/api/v1/integration/environmental-embargoes/layers?type=PROPERTY_ISSUE"

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/environmental-embargoes/layers?type=PROPERTY_ISSUE"))
    .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 response = await fetch(
  'https://api.merx.tech/api/v1/integration/environmental-embargoes/layers?type=PROPERTY_ISSUE',
  {
    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/environmental-embargoes/layers"

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

params = {"type": "PROPERTY_ISSUE"}

response = requests.get(url, headers=headers, params=params)
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

Parâmetros de Query

Nome	Descrição	Tipo	Obrigatório
type	PRODUCER_ISSUE ou PROPERTY_ISSUE. Omitido, devolve os dois	String	Não

Dicionário de dados

Nome	Descrição	Tipo
layer	Identificador da camada. É o valor a enviar no filtro layers	String
layer_name	Nome legível da camada	String

Respostas

• 200 - Ok

[
  { "layer": "EMBARGOS_IBAMA", "layer_name": "IBAMA - EMBARGOS" },
  { "layer": "EMBARGOS_ICMBIO", "layer_name": "ICMBIO - EMBARGOS" },
  { "layer": "INFRACOES_GO", "layer_name": "SEMAD-GO - INFRACOES" },
  { "layer": "PRODES_AMAZONIA", "layer_name": "PRODES - AMAZONIA" }
]

Ordenado por layer.

• 400 - Bad Request

{
  "messages": ["message.layer-type.invalid"]
}

• 401 - Unauthorized