MENU


Introdução

Premissas

Métodos

Propriedades

Fornecedores

Parceiros

Relatórios

Introdução

Bem-vindo à documentação de integração do Informative.

Este documento apresenta os métodos que o cliente deverá fornecer para a realização do setup e integração dos dados.


Premissas

Liberação de acesso

Protocolo Seguro:

Autenticação:

Documentação:


Métodos

Propriedades

Método responsável por retornar apenas os dados únicos das propriedades, eliminando qualquer duplicidade que possa ocorrer.

Parâmetros

Título Obrigatório Descrição
Unidade não Caso a empresa possua mais de uma unidade, ao passar esse parâmetro deverá filtrar as propriedades
Código do fornecedor ou parceiro não Caso preenchido esse parâmetro, deverá retornar somente as propriedades desse produtor ou parceiro
CPF ou CNPJ não Caso preenchido esse parâmetro, deverá retornar somente as propriedades desse produtor ou parceiro
Código da propriedade não Caso preenchido esse parâmetro, deverá retornar somente os dados da propriedade filtrada

Retorno

Dado Obrigatório
Código sim
Unidade ⚠️
Título sim
CEP sim
Endereço não
Número não
Bairro não
Complemento não
Cidade não
UF/Estado não
Incra não
Área total não
Área produzida não

<aside> ⚠️

Caso tenha mais de uma unidade, no retorno será obrigatório ter o código da unidade.

</aside>


Fornecedores

Método responsável por retornar apenas os dados únicos dos fornecedores, eliminando qualquer duplicidade que possa ocorrer.

Parâmetros

Título Obrigatório Descrição
Código do fornecedor não Caso preenchido esse parâmetro, deverá retornar somente o fornecedor filtrado
CPF ou CNPJ não Caso preenchido esse parâmetro, deverá retornar somente o fornecedor filtrado

<aside> 💡

Caso a empresa opte por utilizar o módulo de aprovação de produtores e parceiros, será necessário enviar os dados de e-mail e celular na integração. O sistema verificará essas informações com o cadastro do usuário na plataforma. Se houver correspondência em pelo menos um desses dados, a aprovação será feita automaticamente. Caso contrário, a aprovação deverá ser realizada manualmente pelo painel administrativo.

</aside>

Caso o produtor tenha apenas um contrato, as propriedades deverão vir juntas seguindo a estrutura abaixo

Caso o fornecedor tenha apenas um contrato

Retorno

Dado Obrigatório
Código sim
CPF ou CNPJ sim
Nome sim
Celular não
E-mail não
Código das propriedades sim
{
    "codigo":"1061",
    "nome":"Pedro Silva",
    "cpf_cnpj":"362.112.124-12",
    "celular":"1699999999",
    "email":"[email protected]",
    "propriedades": [
        1004,
        1005,
        1006
    ]
}

Caso o fornecedor tenha mais de um contrato

Retorno

Caso a empresa tenha mais de um contrato com os mesmos produtores, e precise passar as propriedades por contrato do usuário deverá usar a estrutura abaixo

| --- | --- |


Parceiros