AR1 - Listar todas as campanhas - EEmovel

Este recurso devolve uma lista de campanhas disponíveis com seus dados resumidos.

Endpoint: /campaing

Exemplo de solicitação utilizando a linguagem PHP:

<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL =>
"https://api.master.agronavis.com.br/agro/hub/delivery/internal/v1/campaing",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => "",
CURLOPT_HTTPHEADER => [
"x-api-key: token_api_aqui"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}

Método	Parâmetro	Tipo	Observação
GET	x-api-key	header	Obtido através de solicitação à Agronavis

Exemplo de retorno:
{
    "data": [
        {
            "id": 84892,
            "layer_count": 0,
            "name": "Campanha Documentação",
            "realty_count": 2
        },
    ],
    "error": false,
    "message_id": "Success",
}

A propriedade “data” retorna uma lista com todas as campanhas de forma resumida. Onde:

Chave	Formato	Descrição valor
id	Integer	Identificador da campanha. Este valor pode ser solicitado em outros endpoints desta API
layer_count	Integer	Quantidade de camadas na campanha
name	String	Nome da campanha
realty_count	Integer	Quantidade de propriedades na campanha
error	Boolean	False caso a requisição seja realizada com sucesso. True, caso contrário.
message_id	String	Mensagem de sucesso ou motivo da falha