Manual de Integração

O sistema Apatu oferece duas formas de integração: por webservice REST e via arquivo XML.

 

Integração por arquivo XML

O serviço de integração Apatu Imóveis por arquivo XML tem por objetivo atualizar as informações dos imóveis automaticamente, por meio da leitura de dados de provedores externos (sistemas de cadastro de imóveis, sistemas internos das imobiliárias, etc.).

Funcionamento

Para que os dados de uma imobiliária sejam sincronizados, o primeiro passo é informar o endereço (URL) do serviço que provê as informações sobre os imóveis através de um arquivo XML. 

Exemplo: http://exemplo.meusistema.com.br

O sistema Apatu Imóveis irá ler automaticamente (às 12h00 e às 18h00) os dados fornecidos e, desde que estejam no formato correto, descrito abaixo, irá atualizar as informações dos imóveis.

Observações:

  • Imóveis cadastrados manualmente não serão alterados pela sincronização;
  • Alterações feitas manualmente (através da Central Apatu) serão sobrescritas na sincronização;

Padrão do arquivo XML

Clique aqui para visualizar o arquivo modelo da integração.

 

Integração por webservice REST

Para uma integração em tempo real, é possível utilizar o webservice APATU enviando os dados a qualquer momento a partir do sistema de gerenciamento da imobiliária ou corretor.

Funcionamento

O primeiro passo para utilizar o webservice é anotar os dados de sincronização da imobiliária (código, chave de segurança). Esses dados podem ser obtidos acessando a Central Apatu, conforme imagens abaixo.

 

Obtendo o código:

Para obter o código, basta acessar a lista de imobiliárias gerenciadas e anotar o Código presente na primeira coluna, conforme imagem abaixo.

 

 

Obtendo a chave de segurança:

Em seguida, para obter a chave de segurança, acesse os dados da imobiliária clicando no botão Editar na lista de imobiliárias. O campo Chave de sincronização irá conter a chave de sincronização para a imobiliária selecionada.

 

 

Importante: não revele a chave a estranhos. Por meio dela é possível incluir, alterar e excluir os dados dos seus imóveis.

 

Sincronizar imóvel (/sincronizar-imovel):

O serviço "sincronizar-imovel" é utilizado para enviar dados dos imóveis. Se a referência do imóvel não existir no sistema, esse será cadastrado. Se a referência existir, o mesmo será completamente atualizado.

Importante: Para atualizar os dados de um imóvel, todos os seus dados devem ser enviados novamente, inclusive as fotos. Dados não enviados serão descartados pelo sistema.

Endereço:
https://central.apatuimoveis.com.br/ws/sincronizar-imovel/CODIGO DA IMOBILIÁRIA/CHAVE DE SEGURANÇA/REFERÊNCIA DO IMÓVEL

Parâmetros:

  • destaque (booleano): Indica se o imóvel deve ser destacado
  • exclusivo (booleano): Indica se o imóvel é exclusivo
  • mobiliado (booleano): Indica se o imóvel é mobiliado
  • aceitaFinanciamento (booleano): Indica se o imóvel aceita financiamento
  • endereco (texto): Endereço do imóvel
  • numero (texto): Número
  • cep (texto): CEP
  • complemento (texto): Complemento do endereço
  • area (decimal): Área total
  • areaConstruida (decimal): Área construída
  • areaUtil (decimal): Área útil
  • tempoConstrucao (inteiro): Tempo de construção (em meses)
  • valor* (decimal): Valor da negociação (valor de locação para locações / valor de venda para vendas)
  • valorIptu (decimal): Valor do IPTU
  • valorCondominio (decimal): Valor do condomínio
  • youtube (texto): Endereço do imóvel no Youtube
  • titulo (texto): Título do imóvel no sistema. Ex: Ótimo imóvel situado em...
  • descricao (texto): Descrição completa do imóvel.
  • imovelTipo* (código de referência): Tipo do imóvel
  • tipoServico* (código de referência): Tipo do serviço
  • bairro (texto): Nome do bairro
  • cidade (texto): Nome da cidade
  • uf (texto): Sigla do estado
  • situacao (código de referência): Situação do imóvel

* parâmetros obrigatórios

Clique aqui para visualizar os valores para os campos do tipo "código de referência".

Existem ainda dois campos especiais, onde o código de referência é utilizado no nome do campo.

  • imovelItemX (booleano): Indica que o imóvel possui o item indicado pelo código X.
  • comodoX (inteiro): Indica a quantidade de cômodos indicado pelo código X, que o imóvel possui.

Excluir imóvel (/excluir-imovel):

O serviço "excluir-imovel" é utilizado para remover um registro de imóvel. 

Endereço:
https://central.apatuimoveis.com.br/ws/excluir-imovel/CODIGO DA IMOBILIÁRIA/CHAVE DE SEGURANÇA/REFERÊNCIA DO IMÓVEL

 

Em caso de dúvida, utilize a página de contato. Estamos a disposição para auxiliar no processo de integração.