Buscar dados do CAR pelo código

Descrição: Busca os dados completos de um Cadastro Ambiental Rural (CAR) pelo código do imóvel.

Endpoint

GET/api/v1/integration/car/{car}

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
car	Código do Cadastro Ambiental Rural	String	Sim	-

Exemplo de Requisição

cURL

curl -X GET \
  -H "Authorization: {SUA_API_KEY}" \
  "https://api.merx.tech/api/v1/integration/car/MT-5107925-A1B2C3D4E5F6"

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/car/MT-5107925-A1B2C3D4E5F6"))
    .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/car/MT-5107925-A1B2C3D4E5F6',
  {
    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/car/MT-5107925-A1B2C3D4E5F6"

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

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

SDK Java

import com.merx.sdk.api.MerxClient;
import com.merx.sdk.core.Environment;

MerxClient merx = MerxClient.builder()
    .apiKey("{SUA_API_KEY}")
    .environment(Environment.SANDBOX)
    .build();

var car = merx.car().findByCode("PR-1234567890");

Parâmetros

Parâmetros de Caminho:

Nome	Descrição	Tipo	Obrigatório
car	Código do Cadastro Ambiental Rural	String	Sim

Parâmetros de Cabeçalho

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

Respostas

• 200 - Ok

{
    "gid": 12345,
    "cod_imovel": "MT-5107909-XXXXXXXXXXXXXXXXXXXXXXXX",
    "data_situacao": 1704067200000,
    "situacao": "string",
    "num_area": 0.0,
    "condicao": "string",
    "cod_estado": "MT",
    "nome_municipio": "string",
    "cod_municipio_ibge": 5107909,
    "num_modulo": 0.0,
    "tipo_imovel": "string",
    "geom": "string",
    "latitude": "-13.0",
    "longitude": "-55.0"
}

Campos sem valor são omitidos da resposta.

• 404 - Not Found

Resposta para um código de CAR que não existe na base da Merx. O corpo vem com a chave genérica de erro, e não com uma mensagem específica de CAR:

{
  "messages": ["message.internal.error"]
}

• 400 - Bad Request

Ocorre quando a consulta ao serviço de CAR retorna vazio em vez de erro. Para um código inexistente o retorno normal é o 404 acima:

{
  "messages": ["message.car.not-found"]
}

• 401 - Unauthorized