Documentação Importação/integração XML

Orientações gerais

Este documento tem o objetivo de padronizar o desenvolvimento e disponibilização dos arquivos XML pelas empresas Integradoras ou desenvolvedoras de sistemas imobiliários.

Realizamos neste documento referência a duas personas: INTEGRADOR (aquele que desenvolve os programas ou sistemas imobiliários) e CORRETOR (indivíduo devidamente cadastrado no CRECI e autorizado a usufruir do Portal Imobiliário).

1) INTEGRADOR: As regras abaixo devem ser seguidas em sua totalidade, respeitando e informando todas as informações obrigatórias e seus respectivos conteúdos com os formatos pré-determinados neste manual, para que a integração automática junto ao Portal Imobiliário do CRECI aconteça com sucesso.

2) INTEGRADOR: Todos os arquivos devem possuir o formato XML (de acordo com um dos dois padrões disponibilizados e que podem ser adotados - formato CRECI ou ZAP (MODELO ANTIGO - atentar ao modelo).

3) INTEGRADOR: Estes arquivos devem ser disponibilizados através de uma URL (ex.: www.dominioqualquer.com.br/nomedoarquivo.xml ).

4) INTEGRADOR: informe ao corretor o endereço da URL que foi disponibilizado o XML e qual é o formato desenvolvido (se é formato CRECI ou ZAP), para que o corretor possa cadastrar corretamente este XML dentro do Portal Imobiliário do CRECI.

5) CORRRETOR: De posse desta URL (link), você deverá acessar o portal imobiliário do CRECI e dentro do menu importações cadastrar seu XML disponibilizado pela Empresa Integradora ou Desenvolvedora de Sistemas Imobiliários.

6) CORRETOR: Você possui dúvidas de como cadastrar o XML? confira em nossos vídeos na página inicial deste tutorial e escolha o vídeo "Como inserir um XML para integrar os imóveis de forma automática?".

Leia com atenção todas as regras abaixo com os pontos mais importantes para o desenvolvimento e disponibilização deste arquivo XML.

Atualizado em 02/08/2022

Escolha o item desejado abaixo

Orientações gerais

Escolha o item desejado abaixo

O que é a importação XML?

Como funciona?

Atenção, a cada leitura diária *:

Qual a Restrição?

Quais os Padrões de XML?

Padrão Portal CRECI

Layout do XML: Formato CRECI

Especificações (formato CRECI)

Tipos do imóvel (formato CRECI)

Subtipos do imóvel (formato CRECI)

Padrão ZAP Imóveis (Modelo Antigo)*

Layout do XML: Formato ZAP (Modelo Antigo)*

Especificações - formato ZAP (Modelo Antigo)*

Tabela de Tipo, Subtipos e Categorias do imóvel - formato ZAP (Modelo Antigo)*

O que é a importação XML?

O XML é um formato de arquivo adotado para troca de informações entre diversos sistemas utilizando a Internet como meio de comunicação.

Para facilitar a integração com o portal de imóveis do CRECI de forma automática, é necessário a disponibilização deste arquivo neste formato XML para integração de seus imóveis.

Todos imóveis deverão ser listados dentro deste arquivo no formato XML , respeitando padrões e regras aqui definidos, e assim poderão ser importados no portal de imóveis do CRECI para a sua respectiva conta/login do corretor.

Como funciona?

De posse da URL (link) disponibilizado pela Integradora (Desenvolvedores de Sistemas Imobiliários) o corretor deverá cadastrar esta URL (link) dentro do Portal Imobiliário em sua respectiva conta/login.

Diariamente o portal irá ler esta URL (link) do XML cadastrado em sua conta, caso todas as regras de preenchimento do padrão XML adotado estiverem corretas (regras que estão descritas neste manual), o sistema irá gravar os imóveis válidos dentro do portal imobiliário do CRECI.

O formato deste XML deve seguir os padrões definidos nessa documentação, principalmente as regras obrigatórias (constantes na coluna como obrigatórias) para que a carga seja lida corretamente.

Também é importante que a URL (link) esteja em pleno funcionamento para que o importador consiga realizar sua leitura.

Caso haja algum erro na publicação, no painel de importação de sua conta, você irá enxergar todos os detalhes do(s) erro(s) que estarão disponíveis para que sejam realizadas as devidas correções.

Atenção, a cada leitura diária *:

Todos os seus imóveis da carga anterior que não estejam na nova carga serão removidos. (desde que o link/URL do XML cadastrado não seja alterado e nem excluído). O Portal analisa se houve modificações referente a cada link/URL informado. (aconselhável apenas manter um link de importação XML cadastrado dentro do Portal).
Todos os seus imóveis da carga anterior que estejam na nova carga e que sofreram modificações, serão atualizados.
Todas as fotos da carga anterior que não estejam na nova carga serão removidas.
Todas as fotos da nova carga que não existiam, serão inseridas.
As fotos são otimizadas e armazenadas por nossos servidores, se a URL da foto é a mesma o sistema não realizará o download novamente, caso necessite de atualização favor atualizar a URL da foto.

(* reiterando que esse procedimento acontecerá desde que você não modifique o endereço da URL / link que está sendo integrado os seus imóveis, ou seja, se você alterar esse endereço de URL / link de integração em uma próxima leitura, esse procedimento não irá funcionar).

Qual a Restrição?

O acesso ao portal somente estará disponível se o CORRETOR estiver regularmente inscrito no Conselho Regional de Corretores de Imóveis (CRECI).
Caso o CORRETOR não possua este arquivo XML (link disponibilizado pelo seu INTEGRADOR), não é possivel realizar a integração dos imóveis de forma automática, devendo assim o corretor realizar o cadastro manual de seus imóveis.

Quais os Padrões de XML?

Atualmente o Portal Imobiliário do CRECI adota os seguintes padrões de XML:

Padrão Portal CRECI
Padrão ZAP Imóveis (modelo adotado é o ANTIGO - (Seguir exatamente o Layout do XML: formato ZAP especificado mais abaixo deste manual.).

Confira abaixo as particularidades de cada padrão XML (O CRECI recomenda que seja utilizado o "padrão portal CRECI").

Padrão Portal CRECI

Este é o formato padrão definido pelo Portal do CRECI (recomendamos que as empresas fornecedoras de software de gestão imobiliária adotem este formato).

Nesse padrão é possível enviar os imóveis para que o portal possa carregar os imóveis dentro do sistema de forma automática.

Este padrão é atualizado constantemente através da criação de novas tags, e a cada alteração é importante realizar o seu devido ajuste.

Layout do XML: Formato CRECI

Abaixo segue um exemplo do resultado esperado do arquivo XML, que deve ser disponibilizado pelo INTEGRADOR

respeite a ordem das tags e a forma que estão escritas as tags, letras minúsculas e maiúsculas.

utilize a tag <![CDATA[ xxxxxx ]]> para conteúdos que tenham caracteres especiais, para que o XML não seja "quebrado" e não seja lido por conta destes caracteres especiais. Repare a sua utilização no exemplo abaixo no campo observação (neste instante utilizar apenas nas tags: obs, city e neighborhood).

ATENÇÃO: remover espacos no inicio e no final , ex de uso incorreto com espaços em branco no inicio e no final: <![CDATA[ teste ]]>

ATENÇÃO:

=> no campo big_file_url e small_file_url : a referência para foto deve ser uma URL válida direta para o arquivo da foto e não deve ser uma montagem em tempo real da foto através de parametrizações na url , exemplo de uma url inválida : https : / / www . nomedodominio . com . br / foto.php?param=arquivootos/asdy13db13.jpg ou https : / / www . nomedodominio . com . br / arquivootos/asdy13db13.jpg+2320-10-2 (esse tipo de parametrização será invalidada e recusada).

=> nos campos numéricos : não separar a casa do milhar com ponto "." , ou seja, por exemplo 215 mil reais não deve ser informado 215.000 , sendo o correto 215000 (sem ponto) ou 215000.00 (com ponto separando as casas decimais).

<client_info>

</client_info>

<common_data>

<total_area>1200.00</total_area>

<useful_area>79.00</useful_area>

<age_year>2020</age_year>

<obs>

<![CDATA[Apartamento na Planta, 79m², 3 dormitórios e 1 Suíte,ou 2 Suítes com Living Ampliado. 2 Vagas, mais de 20 itens de lazer.Ótima Localização. Faça seu fluxo de pagamento.

Entrada mais mensais r$ 590,00

(11) 7778-9955 id 88*103153, CRECI 11]]>

</obs>

<reference_code>91</reference_code>

<master_type>M-1</master_type>

<season_price>1250.00</season_price>

<season_available>1</season_available>

<rent_price></rent_price>

<rent_available>0</rent_available>

<sell_price>10000000000.00</sell_price>

<sell_available>1</sell_available>

<condominium_value>1010.10</condominium_value>

<iptu_value>2020.20</iptu_value>

</purpose>

<show_map>1</show_map>

<show_address>1</show_address>

<type_address>Rua</type_address>

<street_address>Palmeiras</street_address>

<supplements>Apto 43 - Bloco B - Fundos</supplements>

<neighborhood>Barcelona</neighborhood>

<city>São Caetano do Sul</city>

</address>

</common_data>

</composition>

<photo>

<big_file_url>

<![CDATA[

http://118579.motorimobiliario.com.br/pool//118579/52a5462d-de1c-49c7-ae0c-79a7baca9019//52a54b2a-9950-445c-a0eb-91cdbaca9019.B.jpg

]]>

</big_file_url>

<small_file_url>

<![CDATA[

http://118579.motorimobiliario.com.br/pool//118579/52a5462d-de1c-49c7-ae0c-79a7baca9019//52a54b2a-9950-445c-a0eb-91cdbaca9019.C.jpg

]]>

</small_file_url>

<label>Sao Caetano - Espaco mulher</label>

</photo>

<photo>

<big_file_url>

<![CDATA[

http://118579.motorimobiliario.com.br/pool//118579/52a5462d-de1c-49c7-ae0c-79a7baca9019//52a54b2a-9950-445c-a0eb-91cdbaca9019.D.jpg

]]>

</big_file_url>

<small_file_url>

<![CDATA[

http://118579.motorimobiliario.com.br/pool//118579/52a5462d-de1c-49c7-ae0c-79a7baca9019//52a54b2a-9950-445c-a0eb-91cdbaca9019.E.jpg

]]>

</small_file_url>

<label>Sao Caetano - Espaco mulher</label>

</photo>

</photos>

<url >https://youtu.be/3kn-qiA81pk </url >

</youtubelink>

<url >https://youtu.be/GWZ5qQdOqH0 </url >

</youtubelink>

</youtubelinks>

<room>

<label>Dormitórios 1</label>

</room>

</characteristic>

<room>

<label>Dormitórios 2</label>

</room>

</characteristic>

<room>

<label>Dormitórios 3</label>

</room>

</characteristic>

<room>

<label>Suites 1</label>

</room>

</characteristic>

<room>

<label>Vagas 1</label>

</room>

</characteristic>

<room>

<label>Vagas 2</label>

</room>

</characteristic>

<room>

<label>Salas 1</label>

</room>

</characteristic>

</characteristics>

</property>

</properties>

</publish>

Especificações (formato CRECI)

Tipos do imóvel (formato CRECI)

Tipo do Imóvel (formato CRECI)

Subtipos do imóvel (formato CRECI)

Subtipos (formato CRECI)

Padrão ZAP Imóveis (Modelo Antigo)*

Este é o formato baseado na estrutura XML criado pelo Portal ZAP Imóveis (obs.: modelo adotado é o ANTIGO e não o que está em vigor após tornar grupo ZAP, pois o ZAP alterou o layout XML após a união com o Viva Real).

Este padrão foi adotado para facilitar inicialmente o desenvolvimento dos XMLs pelas integradores (que desenvolvem sistemas imobiliários), uma vez que este formato já é amplamente adotado pelo mercado, disponibilizando de forma rápida o XML para o Portal do Creci para seus corretores e imobiliárias que utilizam seus sistemas.

O CRECI adicionou novas tags neste formato para complementar informações durante a integração dos imóveis, por isso consideramos este formato SEMELHANTE (pois acrescenta novas TAGS), mas ressaltamos que a integração irá funcionar mesmo sem estas novas tags que foram acrescentadas.

Para os integradores, solicitamos que incluam estas novas tags, complementando assim as informações dos imóveis dentro do portal do creci.

Abaixo o detalhamento do XML com o seu padrão e as regras básicas que devem ser seguidas para que os imóveis sejam integrados corretamente.

* Siga exatamente o Layout do XML especificado abaixo. Ressaltamos que este formato ZAP mantém todas as tags utilizadas pelo portal ZAP (o formato/layout adotado é o ANTIGO e NÃO é o que está em vigor atualmente), porém algumas Tags foram adicionadas para o Portal Imobiliário.

Layout do XML: Formato ZAP (Modelo Antigo)*

Abaixo segue um exemplo do resultado esperado do arquivo XML, que deve ser disponibilizado pelo INTEGRADOR.

respeite a ordem das tags
respeite a forma que estão escritas as tags: letras minúsculas e maiúsculas.
utilize a tag <![CDATA[ xxxxxx ]]> para conteúdos que tenham caracteres especiais, para que o XML não seja "quebrado" e não seja lido por conta destes caracteres especiais. Repare a sua utilização no exemplo abaixo no campo observação (neste instante utilizar apenas nas tags: observação, cidade e bairro). ATENÇÃO: remover espacos no inicio e no final , ex de uso incorreto com espaços em branco no inicio e no final: <![CDATA[ teste ]]>
ATENÇÃO: na TAG UrlArquivo a referência para foto deve ser uma URL válida direta para o arquivo da foto e não deve ser uma montagem em tempo real da foto através de parametrizações na url , exemplo de uma url inválida : https : / / www . nomedodominio . com . br / foto.php?param=arquivootos/asdy13db13.jpg ou https : / / www . nomedodominio . com . br / arquivootos/asdy13db13.jpg+2320-10-2 (esse tipo de parametrização será invalidada e recusada).

=> nos campos numéricos : não separar a casa do milhar com ponto "." , ou seja, por exemplo 215 mil reais não deve ser informado 215.000 , sendo o correto 215000 (sem ponto) ou 215000.00 (com ponto separando as casas decimais).

<SubTipoImovel>Casa Padrão</SubTipoImovel>

<CategoriaImovel>Térrea</CategoriaImovel>

<Cidade>São Paulo</Cidade>

<Bairro>Pinheiros</Bairro>

<Endereco>Rua Rebelo</Endereco>

Casa 3

</Complemento>

<![CDATA[Casa muito agradável todos dormitórios e salas voltadas para o jardim. Gerador de energia.]]>

</Observacao>

<Fotos>

<Foto>

<URLArquivo>http://cdnx.servidor.com.br/_Fotos/2083/2248/F41104553393CBA7DF130F126201AE61E0CED030.jpg</URLArquivo>

</Foto>

<Foto>

<NomeArquivo>9BF7059650DAECAE4AEB4DE6E74B9FADB663950A.jpg</NomeArquivo>

<URLArquivo>http://cdnx.servidor.com.br/_Fotos/2083/2248/9BF7059650DAECAE4AEB4DE6E74B9FADB663950A.jpg</URLArquivo>

</Foto>

<Foto>

<URLArquivo>http://cdnx.servidor.com.br/_Fotos/2083/2248/4E40F58D79741B233C0D384F6185E86D6BC381BB.jpg</URLArquivo>

</Foto>

</Fotos>

</Imovel>

</Imoveis>

</Carga>

* este formato ZAP mantém todas as tags utilizadas pelo portal ZAP (o formato/layout adotado é o ANTIGO, SIGA exatamente o formato/layout especificado acima, pois NÃO é o formato/layout que está em vigor atualmente), porém algumas Tags foram adicionadas para o Portal Imobiliário.

Especificações - formato ZAP (Modelo Antigo)*

Especificações (formato ZAP)

* este formato ZAP mantém todas as tags utilizadas pelo portal ZAP (o formato/layout é o ANTIGO - seguir exatamente o formato/layout especificado nessa página, pois NÃO é o que está em vigor atualmente pelo ZAP), porém algumas Tags foram adicionadas para o Portal Imobiliário.

Tabela de Tipo, Subtipos e Categorias do imóvel - formato ZAP (Modelo Antigo)*

Tabela Tipos ZAP

* este formato ZAP mantém todas as tags utilizadas pelo portal ZAP (o formato/layout adotado é o ANTIGO - siga exatamente o formato/layout especificado nessa página, pois NÃO é o que está em vigor atualmente pelo ZAP ), porém alguns Tipos, Subtipos e Categorias foram adicionados para o Portal Imobiliário.