En esta página

Panoramix

Cabeçalho do XML

O arquivo deve começar com a declaração padrão: codificação="UTF-8":

<?xml version="1.0" encoding="UTF-8"?>

A seguir define-se a estrutura do XML, respeitando a hierarquia de tags com títulos expansíveis.

OpenNavent

A tag que o arquivo deve ter como root do XML deve ser <OpenNavent>, é a tag de maior hierarquia, as demais tags estão contidas nela.

Data de modificação

Esta tag é utilizada para indicar a data de criação do arquivo XML.

O propósito deste dado é evitar a substituição de um anúncio modificado via API posteriormente à criação do XML.

Desta maneira, se o XML foi gerado às 10:30AM e o anúncio modificado pela API às 10:40AM, quando o XML for processado o anúncio não será modificado.

O valor deve ser enviado no formato Unix Timestamp em milissegundos.

<?xml version="1.0" encoding="UTF-8"?>
<OpenNavent>
  <dataModificacao><![CDATA[1764583681966]]></dataModificacao>
  <Imoveis>
    <Imovel>
      ...
    </Imovel>
  </Imoveis>
</OpenNavent>

Imóveis

Imóvel

O arquivo XML deve seguir a estrutura específica que detalhamos a seguir. Cada anúncio deve estar contido no nó <Imovel>.

Exemplo:

<?xml version="1.0" encoding="UTF-8"?>
<OpenNavent>
  <dataModificacao><![CDATA[1764583681966]]></dataModificacao>
  <Imoveis>
    <Imovel>
      ..
    </Imovel>
  </Imoveis>
</OpenNavent>

Código do Anúncio

O campo <codigoAnuncio> é o que contém a referência principal do seu anúncio, a chave pela qual você poderá acessá-lo e a todos os dados relacionados a partir do momento em que o anúncio for enviado pela primeira vez.

O <codigoAnuncio> deve ser único para todas as propriedades gerenciadas pela integração.

O conteúdo pode ser um número ou um código alfanumérico, depende exclusivamente da forma de identificação utilizada pela imobiliária, mas deve ser único e não se repetir dentro do XML. O mesmo não poderá conter mais de 100 caracteres, além disso devem-se evitar acentos.

🚨 Este dado é obrigatório

<?xml version="1.0" encoding="UTF-8"?>
<OpenNavent>
  <dataModificacao><![CDATA[1764583681966]]></dataModificacao>
  <Imoveis>
    <Imovel>
      <codigoAnuncio>REO475061</codigoAnuncio>
    </Imovel>
  </Imoveis>
</OpenNavent>

Código Referência do anúncio

O campo <codigoReferencia> define uma referência própria da imobiliária para identificar o anúncio. Não é obrigatório e, caso exista, não é necessário que seja único.

O conteúdo pode ser um número ou um código alfanumérico, depende exclusivamente da forma de identificação utilizada pela imobiliária.

<?xml version="1.0" encoding="UTF-8"?>
<OpenNavent>
  <dataModificacao><![CDATA[1764583681966]]></dataModificacao>
  <Imoveis>
    <Imovel>
      <codigoReferencia>ABC-123</codigoReferencia>
    </Imovel>
  </Imoveis>
</OpenNavent>

Tipo de Propriedade

O tipo de propriedade é definido com a tag <tipoPropriedade>.

Dentro desta tag, estão contidas as tags idTipo, idSubTipo, tipo e subTipo.

🚨 Este dado é obrigatório.

idTipo

Esta tag é utilizada para indicar o tipo de propriedade que desejamos publicar.

Os IDs disponíveis dos tipos de propriedade, para cada país, podem ser obtidos consultando o EndPoint da API: /v1/tipopropiedades

<?xml version="1.0" encoding="UTF-8"?>
<OpenNavent>
  <dataModificacao><![CDATA[1764583681966]]></dataModificacao>
  <Imoveis>
    <Imovel>
      <tipoPropriedade>
        <idTipo><![CDATA[1]]></idTipo>
      </tipoPropriedade>
    </Imovel>
  </Imoveis>
</OpenNavent>

Tipo

Esta tag é utilizada para indicar o tipo de propriedade que desejamos publicar.

Os valores disponíveis dos tipos de propriedades para cada país podem ser obtidos consultando o EndPoint da API: /v1/tipopropiedades.

Deve-se pegar o valor da key nome, do resultado obtido ao usar o endpoint.

<?xml version="1.0" encoding="UTF-8"?>
<OpenNavent>
  <dataModificacao><![CDATA[1764583681966]]></dataModificacao>
  <Imoveis>
    <Imovel>
      <tipoPropriedade>
        <tipo><![CDATA[Casa]]></tipo>
      </tipoPropriedade>
    </Imovel>
  </Imoveis>
</OpenNavent>

idSubTipo

Alguns tipos de propriedades contam com subtipos de Propriedades.

Os valores disponíveis de cada subtipo de propriedade podem ser obtidos consultando o EndPoint da API: /v1/tipopropiedades/{idtipopropiedad}/subtipos

<?xml version="1.0" encoding="UTF-8"?>
<OpenNavent>
  <dataModificacao><![CDATA[1764583681966]]></dataModificacao>
  <Imoveis>
    <Imovel>
      <tipoPropriedade>
        <idTipo><![CDATA[1]]></idTipo>
        <idSubTipo><![CDATA[44]]></idSubTipo>
      </tipoPropriedade>
    </Imovel>
  </Imoveis>
</OpenNavent>

SubTipo

Alguns tipos de propriedades contam com subtipos.

Os valores disponíveis podem ser obtidos consultando o EndPoint da API: /v1/tipopropiedades/idtipopropiedad/subtipos.

Deve-se pegar o valor da key nome, do resultado obtido ao usar o endpoint.

<?xml version="1.0" encoding="UTF-8"?>
<OpenNavent>
  <dataModificacao><![CDATA[1764583681966]]></dataModificacao>
  <Imoveis>
    <Imovel>
      <tipoPropriedade>
        <tipo><![CDATA[Casa]]></tipo>
        <subTipo><![CDATA[Condominio]]></subTipo>
      </tipoPropriedade>
    </Imovel>
  </Imoveis>
</OpenNavent>

En esta página: