EEmovel - API Agro Hub 3.0
  1. Campanha
EEmovel - API Agro Hub 3.0
  • HAPI - Hub Integration API
    • Introdução
    • Primeiros passos
    • Campanha
      • AR1 - Listar todas as campanhas
      • AR2 - Detalhamento de uma Campanha
      • AR3 - Enriquecer proprietário de uma Campanha
      • AR4 - Listagem de culturas de uma Campanha
      • AR5 - Marcar uma Campanha como sincronizada
      • AR6 - Listagem de dados de camadas filtráveis de uma propriedade na campanha
      • AR7 - Dados de camadas filtráveis da campanha
      • AR1 - Listar todas as campanhas
        GET
      • AR2 - Detalhamento de uma Campanha
        GET
    • Carteira de Clientes
      • AC1 - Inserir um cliente na carteira
  • XAPI - External Integration API
    • Introdução
    • Primeiros passos
    • Produtor
      • Sócios vinculados a um Produtor
      • Impedimento Sociambiental
      • Produtor
    • Propriedade
      • Propriedade Unica
      • Impedimento Socioambiental
  1. Campanha

AR3 - Enriquecer proprietário de uma Campanha

Este recurso devolve os contatos disponíveis de um proprietário que está em uma
campanha. Para isso basta enviar no conteúdo da requisição o documento (CPF ou CNPJ)
e na URL enviar o ID da campanha.
Endpoint: /campaing/{campaing_id}/owner
Exemplo de solicitação utilizando a linguagem PHP:
MétodoParâmetroTipoObservação
POSTx-api-keyheaderObtido através de solicitação à EEmovel
POSTcampaingpath_variableObtido no endpoint de listagem das campanhas
POSTdocumentbodyObjeto com a chave document contendo o valor
Exemplo de retorno:
{
    "code":200,
    "data":{
    "addresses":[
        {
            "city":"CASCAVEL",
            "complement":"",
            "number":"209",
            "street":"R DQ DE CAXIAS",
            "uf":"PR"
        }
    ],
    "birth_date":"1951-05-30T00:00:00Z",
    "document_number":"15633381904",
    "document_type":"CPF",
    "emails":[
        {
        "phone_number[":"luiz_otavio@hotmail.com](mailto:email%22:%22luiz_otavio@hotmail.com)",
        "inserted_in":"2018-03-28T15:18:30Z",
        "is_personal":true,
        "priority":1,
        "score":1
        }
    ],
    "name":"LUIZ CERVI",
    "phones":[
        {
            "from_phones":true,
            "is_mobile":false,
            "phone_number":"4500000000",
            "priority":1,
            "score":11
        }
    ],
    "probableDeath":false
},
    "message":"success",
    "success":true
}
A chave “data” retorna um objeto com informações detalhadas do proprietário. Onde:
ChaveFormatoDescrição valor
birth_dateStringData de nascimento do proprietário
document_numberStringNúmero do documento do proprietário
document_typeBooleanTipo de documento (CPF/CNPJ)
nameStringNome do proprietário
probableDeathStringProprietário provavelmente falecido
A chave “data -> addresses” retorna uma lista com os dados de endereço do proprietário:
ChaveFormatoDescrição valor
cityStringNome da cidade no endereço
complementStringComplemento do endereço
numberBooleanNúmero do endereço
streetStringNome do logradouro
ufStringUnidade da Federação do endereço
A chave “data -> emails” retorna uma lista com os endereços de email do proprietário:
ChaveFormatoDescrição valor
emailStringEndereço de e-mail do proprietário
inserted_inStringData de cadastro
is_personalBooleanSe o endereço é de uso pessoal
priorityIntegerPrioridade do email
scoreIntegerPontuação do e-mail
Modificado em 2025-06-23 18:39:46
Página anterior
AR2 - Detalhamento de uma Campanha
Próxima página
AR4 - Listagem de culturas de uma Campanha
Built with