Integração XML

Manual para imobiliárias e CRMs enviarem anúncios automaticamente ao portal.

1. Introdução

A integração entre o Petrópolis Imóveis e o sistema do anunciante acontece por meio de um arquivo XML disponibilizado no servidor do próprio anunciante, obedecendo ao formato descrito neste manual.

As atualizações são feitas automaticamente a cada 24 horas: imóveis novos entram, alterados são atualizados e os que saírem do XML são removidos do portal.

A carga automática está disponível nos planos que incluem integração. Veja os planos ou fale com a equipe para ativar a sua.

2. Como funciona

Você publica um arquivo XML no padrão abaixo em uma URL pública (ex.: https://www.suaimobiliaria.com.br/portal.xml).
Informa essa URL à equipe do portal, que a associa ao seu cadastro.
Nosso servidor faz uma requisição HTTP a essa URL uma vez por dia e processa o arquivo.
Os imóveis válidos são publicados respeitando as cotas do seu plano (quantidade de imóveis, fotos e destaques).
No painel, em Importação, você acompanha o total lido, os válidos e os rejeitados com o motivo.

Com a carga automática ativa, os menus Meu cadastro e Meus imóveis do painel ficam ocultos: as alterações devem ser feitas no seu sistema de origem.

3. Estrutura do XML

Atenção aos itens obrigatórios: se não existirem ou vierem vazios (ex.: <CodigoImovel></CodigoImovel>) o imóvel não será exibido no portal.

Elemento	Obrigatório	Formato
CodigoImovel	Sim	Número inteiro. Código único do imóvel no sistema do cliente.
TipoImovel	Sim	Máx. 150 caracteres. Use um dos valores aceitos listados abaixo.
Cidade	Sim	Máx. 150 caracteres. Use um dos valores aceitos listados abaixo.
Bairro	Sim	Máx. 150 caracteres. Use um dos valores aceitos listados abaixo.
UF	Sim	Sigla do estado. Ex.: RJ
QtdDormitorios	Não	Número inteiro. Caso não tenha, informar 0.
QtdBanheiros	Não	Número inteiro. Caso não tenha, informar 0.
QtdSuitesnovo	Não	Número inteiro. Quantidade de suítes. Caso não tenha, informar 0.
QtdVagas	Não	Número inteiro. Caso não tenha, informar 0.
AreaUtil	Não	Número inteiro (m²). Caso não tenha, informar 0.
AreaTotal	Não	Número inteiro (m²). Caso não tenha, informar 0.
PrecoVenda	Sim *	Número inteiro, sem pontos, vírgulas ou R$. Ex.: 1500000
PrecoLocacao	Sim *	Número inteiro, sem pontos, vírgulas ou R$. Ex.: 2000
PrecoLocacaoTemporada	Sim *	Número inteiro, sem pontos, vírgulas ou R$. Ex.: 40000
DestaquePortalnovo	Não	0 = sem destaque (padrão), 1 = destaque, 2 = super destaque. A quantidade disponível depende do plano.
InfraEstruturaImovel	Não	Texto com itens separados por ponto e vírgula. Ex.: Piscina;Sauna;Churrasqueira;
DentroCondominio	Sim	0 ou 1 — 1 para imóvel dentro de condomínio e 0 para fora.
InfraEstruturaCondominio	Não	Texto com itens separados por ponto e vírgula. Ex.: Portaria 24h;Piscina;
Taxas	Não	Lista de <Taxa>. Quando presente, TaxaValor e TaxaDescricao são obrigatórios.
↳TaxaValor	Sim **	Valor da taxa, número inteiro.
↳TaxaDescricao	Sim **	Nome da taxa. Ex.: IPTU
↳TaxaObs	Não	Observação sobre a taxa.
Observacao	Sim	Descrição do imóvel. O conteúdo deve estar entre <![CDATA[ ... ]]>.
Fotos	Não	Lista de <Foto>. Quando presente, URLArquivo e Principal são obrigatórios.
↳URLArquivo	Sim **	Máx. 300 caracteres. URL completa da imagem. Ex.: https://www.site.com.br/Upload/foto1.jpg
↳Principal	Sim **	0 ou 1 — a foto com valor 1 será a capa do imóvel.

* Ao menos um dos três campos de preço deve estar preenchido.
** Obrigatório somente quando o elemento pai (Taxas ou Fotos) estiver presente.

4. Exemplo do XML

Arquivo completo com dois imóveis. Use-o como ponto de partida para gerar o seu.

<?xml version='1.0' encoding='UTF-8'?>
<Carga xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:xsd='http://www.w3.org/2001/XMLSchema'>
<Imoveis>
  <Imovel>
    <CodigoImovel>1</CodigoImovel>
    <TipoImovel>Apartamento</TipoImovel>
    <Cidade>Petrópolis</Cidade>
    <Bairro>Itaipava</Bairro>
    <UF>RJ</UF>
    <QtdDormitorios>3</QtdDormitorios>
    <QtdBanheiros>1</QtdBanheiros>
    <QtdSuites>1</QtdSuites>
    <QtdVagas>1</QtdVagas>
    <AreaUtil>300</AreaUtil>
    <AreaTotal>800</AreaTotal>
    <PrecoVenda>1500000</PrecoVenda>
    <PrecoLocacao>2000</PrecoLocacao>
    <PrecoLocacaoTemporada>40000</PrecoLocacaoTemporada>
    <DestaquePortal>1</DestaquePortal>
    <InfraEstruturaImovel>Piscina;Sauna seca;Play ground;Churrasqueira;Garagem;Casa de hóspedes;Portão eletrônico;</InfraEstruturaImovel>
    <DentroCondominio>1</DentroCondominio>
    <InfraEstruturaCondominio>Campo de futebol;Piscina;</InfraEstruturaCondominio>
    <Taxas>
      <Taxa>
        <TaxaValor>167</TaxaValor>
        <TaxaDescricao>IPTU</TaxaDescricao>
        <TaxaObs>Iptu R$ 2.000 ano</TaxaObs>
      </Taxa>
      <Taxa>
        <TaxaValor>1000</TaxaValor>
        <TaxaDescricao>Caseiro</TaxaDescricao>
      </Taxa>
    </Taxas>
    <Observacao>
      <![CDATA[
        Descrição Imóvel
      ]]>
    </Observacao>
    <Fotos>
      <Foto>
        <URLArquivo>http://www.petropolisimoveis.com.br/Upload/Imovel-cod-1-foto1.jpg</URLArquivo>
        <Principal>1</Principal>
      </Foto>
      <Foto>
        <URLArquivo>http://www.petropolisimoveis.com.br/Upload/Imovel-cod-1-foto2.jpg</URLArquivo>
        <Principal>0</Principal>
      </Foto>
    </Fotos>
  </Imovel>
  <Imovel>
    <CodigoImovel>2</CodigoImovel>
    <TipoImovel>Casa</TipoImovel>
    <Cidade>Petrópolis</Cidade>
    <Bairro>Itaipava</Bairro>
    <UF>RJ</UF>
    <QtdDormitorios>3</QtdDormitorios>
    <QtdBanheiros>1</QtdBanheiros>
    <QtdSuites>0</QtdSuites>
    <QtdVagas>1</QtdVagas>
    <AreaUtil>300</AreaUtil>
    <AreaTotal>800</AreaTotal>
    <PrecoVenda>1500000</PrecoVenda>
    <PrecoLocacao>2000</PrecoLocacao>
    <PrecoLocacaoTemporada>40000</PrecoLocacaoTemporada>
    <DestaquePortal>0</DestaquePortal>
    <InfraEstruturaImovel>Piscina;Sauna seca;Play ground;Churrasqueira;Garagem;Casa de hóspedes;Portão eletrônico;</InfraEstruturaImovel>
    <DentroCondominio>1</DentroCondominio>
    <InfraEstruturaCondominio>Campo de futebol;Piscina;</InfraEstruturaCondominio>
    <Taxas>
      <Taxa>
        <TaxaValor>167</TaxaValor>
        <TaxaDescricao>IPTU</TaxaDescricao>
        <TaxaObs>Iptu R$ 2.000 ano</TaxaObs>
      </Taxa>
      <Taxa>
        <TaxaValor>1000</TaxaValor>
        <TaxaDescricao>Caseiro</TaxaDescricao>
      </Taxa>
    </Taxas>
    <Observacao>
      <![CDATA[
        Descrição Imóvel
      ]]>
    </Observacao>
    <Fotos>
      <Foto>
        <URLArquivo>http://www.petropolisimoveis.com.br/Upload/Imovel-cod-1-foto1.jpg</URLArquivo>
        <Principal>1</Principal>
      </Foto>
      <Foto>
        <URLArquivo>http://www.petropolisimoveis.com.br/Upload/Imovel-cod-1-foto2.jpg</URLArquivo>
        <Principal>0</Principal>
      </Foto>
    </Fotos>
  </Imovel>
</Imoveis>
</Carga>

5. Valores aceitos

Os elementos TipoImovel, Cidade e Bairro precisam usar exatamente os textos abaixo (acentos incluídos). Imóveis com valores fora da lista são rejeitados.

Tipos de imóvel

Apartamento
Casa
Loja
Cobertura
Terreno Comercial
Flat
Sala
Terreno Residencial
Fazenda / Sítio
Sobreloja
Galpão
Haras
Chácara
Kitnet / Conjugado
Hotel
Pousada
Imóvel Comercial
Studio
Outros
Área

Cidades e bairros

Cidade	Bairros
Petrópolis - RJ	Alto da Serra · Araras · Bingen · Carangola · Castelânea · Centro · Coronel Veiga · Corrêas · Duarte da Silveira · Floresta · Independência · Itaipava · Morin · Mosela · Nogueira · Quarteirão Brasileiro · Quarteirão Ingelheim · Quitandinha · Retiro · Roseiral · Saldanha Marinho · Samambaia · São Sebastião · Secretário · Valparaíso
Três Rios - RJ	Boa União

6. Observações importantes

O arquivo XML deve utilizar encoding UTF-8.
Imóveis que não estiverem no XML serão removidos do portal na próxima atualização.
A quantidade de imóveis, fotos por imóvel e destaques disponíveis depende do plano contratado.
Fotos são baixadas pela URL informada; use links públicos, estáveis e em alta resolução (recomendado 800×600 ou maior).
Os campos QtdSuites e DestaquePortal são novos e opcionais; arquivos antigos continuam válidos.

Elemento

Obrigatório

Formato

CodigoImovel

Sim

Número inteiro. Código único do imóvel no sistema do cliente.

TipoImovel

Sim

Máx. 150 caracteres. Use um dos valores aceitos listados abaixo.

Cidade

Sim

Máx. 150 caracteres. Use um dos valores aceitos listados abaixo.

Bairro

Sim

Máx. 150 caracteres. Use um dos valores aceitos listados abaixo.

Sim

Sigla do estado. Ex.: RJ

QtdDormitorios

Não

Número inteiro. Caso não tenha, informar 0.

QtdBanheiros

Não

Número inteiro. Caso não tenha, informar 0.

QtdSuitesnovo

Não

Número inteiro. Quantidade de suítes. Caso não tenha, informar 0.

QtdVagas

Não

Número inteiro. Caso não tenha, informar 0.

AreaUtil

Não

Número inteiro (m²). Caso não tenha, informar 0.

AreaTotal

Não

Número inteiro (m²). Caso não tenha, informar 0.

PrecoVenda

Sim *

Número inteiro, sem pontos, vírgulas ou R$. Ex.: 1500000

PrecoLocacao

Sim *

Número inteiro, sem pontos, vírgulas ou R$. Ex.: 2000

PrecoLocacaoTemporada

Sim *

Número inteiro, sem pontos, vírgulas ou R$. Ex.: 40000

DestaquePortalnovo

Não

0 = sem destaque (padrão), 1 = destaque, 2 = super destaque. A quantidade disponível depende do plano.

InfraEstruturaImovel

Não

Texto com itens separados por ponto e vírgula. Ex.: Piscina;Sauna;Churrasqueira;

DentroCondominio

Sim

0 ou 1 — 1 para imóvel dentro de condomínio e 0 para fora.

InfraEstruturaCondominio

Não

Texto com itens separados por ponto e vírgula. Ex.: Portaria 24h;Piscina;

Taxas

Não

Lista de <Taxa>. Quando presente, TaxaValor e TaxaDescricao são obrigatórios.

↳TaxaValor

Sim **

Valor da taxa, número inteiro.

↳TaxaDescricao

Sim **

Nome da taxa. Ex.: IPTU

↳TaxaObs

Não

Observação sobre a taxa.

Observacao

Sim

Descrição do imóvel. O conteúdo deve estar entre <![CDATA[ ... ]]>.

Fotos

Não

Lista de <Foto>. Quando presente, URLArquivo e Principal são obrigatórios.

↳URLArquivo

Sim **

Máx. 300 caracteres. URL completa da imagem. Ex.: https://www.site.com.br/Upload/foto1.jpg

↳Principal

Sim **

0 ou 1 — a foto com valor 1 será a capa do imóvel.

<?xml version='1.0' encoding='UTF-8'?> <Carga xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:xsd='http://www.w3.org/2001/XMLSchema'> <Imoveis> <Imovel> <CodigoImovel>1</CodigoImovel> <TipoImovel>Apartamento</TipoImovel> <Cidade>Petrópolis</Cidade> <Bairro>Itaipava</Bairro> <UF>RJ</UF> <QtdDormitorios>3</QtdDormitorios> <QtdBanheiros>1</QtdBanheiros> <QtdSuites>1</QtdSuites> <QtdVagas>1</QtdVagas> <AreaUtil>300</AreaUtil> <AreaTotal>800</AreaTotal> <PrecoVenda>1500000</PrecoVenda> <PrecoLocacao>2000</PrecoLocacao> <PrecoLocacaoTemporada>40000</PrecoLocacaoTemporada> <DestaquePortal>1</DestaquePortal> <InfraEstruturaImovel>Piscina;Sauna seca;Play ground;Churrasqueira;Garagem;Casa de hóspedes;Portão eletrônico;</InfraEstruturaImovel> <DentroCondominio>1</DentroCondominio> <InfraEstruturaCondominio>Campo de futebol;Piscina;</InfraEstruturaCondominio> <Taxas> <Taxa> <TaxaValor>167</TaxaValor> <TaxaDescricao>IPTU</TaxaDescricao> <TaxaObs>Iptu R$ 2.000 ano</TaxaObs> </Taxa> <Taxa> <TaxaValor>1000</TaxaValor> <TaxaDescricao>Caseiro</TaxaDescricao> </Taxa> </Taxas> <Observacao> <![CDATA[ Descrição Imóvel ]]> </Observacao> <Fotos> <Foto> <URLArquivo>http://www.petropolisimoveis.com.br/Upload/Imovel-cod-1-foto1.jpg</URLArquivo> <Principal>1</Principal> </Foto> <Foto> <URLArquivo>http://www.petropolisimoveis.com.br/Upload/Imovel-cod-1-foto2.jpg</URLArquivo> <Principal>0</Principal> </Foto> </Fotos> </Imovel> <Imovel> <CodigoImovel>2</CodigoImovel> <TipoImovel>Casa</TipoImovel> <Cidade>Petrópolis</Cidade> <Bairro>Itaipava</Bairro> <UF>RJ</UF> <QtdDormitorios>3</QtdDormitorios> <QtdBanheiros>1</QtdBanheiros> <QtdSuites>0</QtdSuites> <QtdVagas>1</QtdVagas> <AreaUtil>300</AreaUtil> <AreaTotal>800</AreaTotal> <PrecoVenda>1500000</PrecoVenda> <PrecoLocacao>2000</PrecoLocacao> <PrecoLocacaoTemporada>40000</PrecoLocacaoTemporada> <DestaquePortal>0</DestaquePortal> <InfraEstruturaImovel>Piscina;Sauna seca;Play ground;Churrasqueira;Garagem;Casa de hóspedes;Portão eletrônico;</InfraEstruturaImovel> <DentroCondominio>1</DentroCondominio> <InfraEstruturaCondominio>Campo de futebol;Piscina;</InfraEstruturaCondominio> <Taxas> <Taxa> <TaxaValor>167</TaxaValor> <TaxaDescricao>IPTU</TaxaDescricao> <TaxaObs>Iptu R$ 2.000 ano</TaxaObs> </Taxa> <Taxa> <TaxaValor>1000</TaxaValor> <TaxaDescricao>Caseiro</TaxaDescricao> </Taxa> </Taxas> <Observacao> <![CDATA[ Descrição Imóvel ]]> </Observacao> <Fotos> <Foto> <URLArquivo>http://www.petropolisimoveis.com.br/Upload/Imovel-cod-1-foto1.jpg</URLArquivo> <Principal>1</Principal> </Foto> <Foto> <URLArquivo>http://www.petropolisimoveis.com.br/Upload/Imovel-cod-1-foto2.jpg</URLArquivo> <Principal>0</Principal> </Foto> </Fotos> </Imovel> </Imoveis> </Carga>

Cidade

Bairros

Petrópolis - RJ

Alto da Serra · Araras · Bingen · Carangola · Castelânea · Centro · Coronel Veiga · Corrêas · Duarte da Silveira · Floresta · Independência · Itaipava · Morin · Mosela · Nogueira · Quarteirão Brasileiro · Quarteirão Ingelheim · Quitandinha · Retiro · Roseiral · Saldanha Marinho · Samambaia · São Sebastião · Secretário · Valparaíso

Três Rios - RJ

Boa União