Buscar dados da fazenda pelo identificador (ID)

Descrição: Busca os dados da fazenda a partir do id.

Endpoint

GET/api/v1/integration/farms/{farm_id}

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
farm_id	Identificador da fazenda	UUID	Sim	-

Exemplo de Requisição

cURL

curl -X GET \
  -H "Authorization: {SUA_API_KEY}" \
  "https://api.merx.tech/api/v1/integration/farms/{FARM_ID}"

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/farms/{FARM_ID}"))
    .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/farms/{FARM_ID}',
  {
    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/farms/{FARM_ID}"

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;
import java.util.UUID;

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

var farm = merx.farms().findById(UUID.fromString("00000000-0000-0000-0000-000000000000")).orElseThrow();

Parâmetros

Parâmetros de Caminho:

Nome	Descrição	Tipo	Obrigatório
farm_id	Identificador da fazenda	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

{
    "id": "string",
    "name": "string",
    "latitude": "string",
    "longitude": "string",
    "area": "string",
    "own": true,
    "enabled": true,
    "removed": false,
    "created_at": 1709837511.870898,
    "updated_at": 1709837511.870898,
    "car": "string",
    "registration": "string",
    "state_subscription": "string",
    "logistics": "string",
    "address_id": "string",
    "address": {
        "id": "string",
        "street": "string",
        "number": "string",
        "complement": "string",
        "neighborhood": "string",
        "zip_code": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "enabled": true,
        "removed": false,
        "created_at": 1709837511.870898,
        "updated_at": 1709837511.870898
    }
}

Campos sem valor são omitidos da resposta.

• 400 - Bad Request

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

• 401 - Unauthorized

• 404 - NotFound