Do seu CRM para a CréditoCasa.pt
Modelo XML para integrar os seus imóveis
Disponibilize os seus imóveis na CréditoCasa.pt através do seu CRM imobiliário. Descarregue o nosso modelo XML e peça ao fornecedor do seu CRM que adapte o ficheiro à estrutura e aos campos indicados.
Como integrar
- Descarregue o modelo XML e consulte os campos necessários.
- Adapte o seu XML ao nosso modelo, com o apoio do fornecedor do CRM. Use UTF-8 e inclua a lista completa dos imóveis que pretende publicar.
- Partilhe uma ligação HTTPS estável para o ficheiro através do e indique o CRM que utiliza e os eventuais requisitos de acesso.
- A nossa equipa valida o ficheiro e combina consigo a ativação da integração e a frequência das atualizações.
A adaptação do XML deve ser feita pelo anunciante ou pelo fornecedor do CRM, seguindo este modelo. A CréditoCasa.pt lê o ficheiro a partir da ligação fornecida, após validação pela nossa equipa. Esta página não disponibiliza uma API para enviar imóveis.
Um imóvel, com agência e fotografias
Repita o elemento property dentro de feed para cada imóvel. Em feeds com várias agências, inclua a agência responsável em cada imóvel. Todos os dados e endereços deste exemplo são fictícios; substitua-os pelos seus, incluindo as URLs das fotografias e o email do anunciante.
<?xml version="1.0" encoding="UTF-8"?>
<!-- Exemplo fictício. Substitua os dados e URLs antes de integrar. -->
<feed>
<property>
<external_id>demo-0001</external_id>
<reference>DEMO-T2-001</reference>
<transaction_type>sale</transaction_type>
<price>285000</price>
<property_type>apartment</property_type>
<country>Portugal</country>
<district>Lisboa</district>
<municipality>Lisboa</municipality>
<parish>Arroios</parish>
<latitude>38.7223</latitude>
<longitude>-9.1393</longitude>
<typology>T2</typology>
<bedrooms>2</bedrooms>
<bathrooms>2</bathrooms>
<area_useful>85.5</area_useful>
<area_gross>100</area_gross>
<area_land>0</area_land>
<energy_certificate>B</energy_certificate>
<condition>Usado</condition>
<description><![CDATA[Apartamento T2 com varanda & garagem. Exemplo fictício para integração.]]></description>
<source_url>https://example.com/imoveis/demo-0001?origem=crm&idioma=pt</source_url>
<agency>
<external_id>agencia-demo</external_id>
<name>Agência de Exemplo</name>
<email>agencia@example.com</email>
<ami_license>00000</ami_license>
<address>Rua de Exemplo, 1</address>
<postal_code>1000-000</postal_code>
<city>Lisboa</city>
<phone>+351 210 000 000</phone>
<mobile_phone>+351 910 000 000</mobile_phone>
<website>https://example.com</website>
<logo_url>https://example.com/imagens/logotipo.png</logo_url>
</agency>
<images>
<image>
<url>https://example.com/imagens/demo-0001-1.jpg</url>
</image>
<image>
<url>https://example.com/imagens/demo-0001-2.jpg</url>
</image>
</images>
</property>
</feed>
Use elementos sem prefixos de namespace e mantenha a estrutura consistente. Para campos opcionais desconhecidos, omita o elemento; não envie os textos null, undefined ou N/A. Escape caracteres XML ou use CDATA para descrições.
Campos do imóvel
Os caminhos seguintes são relativos a feed/property. Os campos obrigatórios são o mínimo para importar. Para publicar o anúncio na CréditoCasa.pt, inclua pelo menos uma fotografia. Tipologia e certificado energético são opcionais, mas, quando enviados, têm de usar um dos valores aceites.
| Campo XML | Necessidade | Formato e significado |
|---|---|---|
| external_id | Obrigatório | Texto. Identificador único do imóvel dentro da fonte. Deve permanecer igual em todas as atualizações, mesmo que a referência comercial mude. |
| transaction_type | Obrigatório | Código da operação: por exemplo, sale (venda) ou rent (arrendamento). Consulte todos os valores abaixo. |
| price | Obrigatório | Número superior a zero, em euros. Use 285000 ou 285000.50, sem símbolo € nem separador de milhares. No arrendamento, indique o valor mensal no XML. |
| property_type | Obrigatório | Código do tipo de imóvel: por exemplo, apartment (apartamento) ou house (moradia). |
| reference | Recomendado | Texto. Referência comercial apresentada ao público. Não substitui o external_id. |
| country | Recomendado | Nome do país. Na ausência deste campo, o valor por defeito é Portugal. |
| district / municipality / parish | Recomendado | Três elementos separados: distrito, concelho e freguesia. Use as designações oficiais portuguesas para facilitar a pesquisa por localização. |
| typology | Recomendado | Tipologia canónica, como T2. Omita quando não se aplica ou é desconhecida; não invente um valor. |
| bedrooms / bathrooms | Opcional | Dois elementos separados, com números inteiros: quartos e casas de banho. |
| area_useful / area_gross / area_land | Recomendado | Três elementos separados: área útil, bruta e do terreno, em m². Use ponto decimal, por exemplo 85.5. Omita áreas desconhecidas. |
| energy_certificate | Recomendado | Valor da lista abaixo. Omita se desconhecido; use Isento ou Não aplicável apenas quando correspondem ao imóvel. |
| condition | Opcional | Texto com o estado de conservação, por exemplo Usado, Novo ou Em construção. |
| description | Recomendado | Descrição em português. Use texto simples ou CDATA; inclua condições e características relevantes, sem depender de HTML. |
| latitude / longitude | Opcional | Dois elementos separados, em graus decimais, por exemplo 38.7223 e -9.1393. Omita coordenadas desconhecidas em vez de enviar zero. |
| source_url | Recomendado | URL absoluta da página original do imóvel. Escape & como & quando estiver fora de CDATA. |
| images / image / url | Para publicação | Lista de fotografias com URLs absolutas HTTPS, acessíveis sem sessão. Uma imagem por elemento image. A primeira é a principal; a ordem do XML é preservada. |
Dados da agência ou anunciante
Inclua estes campos dentro de property/agency. O email é necessário para o anunciante receber pedidos de contacto através da CréditoCasa.pt, mesmo que o ficheiro possa ser importado sem esse campo.
| Campo XML | Necessidade | Formato e significado |
|---|---|---|
| external_id | Obrigatório | Texto. Identificador estável da agência dentro da fonte. Repita o mesmo identificador em todos os seus imóveis; não o reutilize para outra agência. |
| name | Obrigatório | Nome comercial do anunciante responsável pelo imóvel. |
| Para contactos | Email válido do anunciante para receber os pedidos relativos ao imóvel. Deve coincidir com o email usado no registo profissional para associar os imóveis à conta. | |
| ami_license | Recomendado | Texto com o número da licença AMI, quando aplicável. |
| phone / mobile_phone | Recomendado | Dois elementos separados, em texto, com indicativo internacional. Omita contactos que não existam. |
| address / postal_code / city | Opcional | Três elementos separados: morada, código postal e localidade da agência. |
| website / logo_url | Opcional | Dois elementos separados, com URLs absolutas HTTPS do site e do logótipo da agência. |
Valores aceites
Adapte os valores do seu CRM aos códigos apresentados abaixo, respeitando maiúsculas e acentos.
Operação
transaction_type
- sale
- Venda
- rent
- Arrendamento
- transfer
- Trespasse
- transfer_sale
- Trespasse com venda de imóvel
- transfer_rent
- Trespasse com arrendamento de imóvel
- sale_or_rent
- Venda/Arrendamento
- holiday_rent
- Arrendamento para férias
- temporary_rent
- Arrendamento temporário
- exchange
- Permuta
- share_transfer
- Cedência de quotas
- other
- Outros
Tipo de imóvel
property_type
- apartment
- Apartamento
- house
- Moradia
- land
- Terreno
- farm
- Quinta
- shop
- Loja
- office
- Escritório
- warehouse
- Armazém
- garage
- Garagem
- building
- Prédio
- room
- Quarto
- other
- Outro
Tipologia · typology
T0 · T1 · T2 · T3 · T4 · T5 · T6 · T6+
Certificado energético · energy_certificate
A+ · A · B · B- · C · D · E · F · G · Isento · Não aplicável · Em trâmite
Atualizações e remoções
- Envie sempre a lista completa. Este fluxo não é incremental. Não envie apenas os imóveis alterados desde a última sincronização.
- Mantenha os identificadores. Uma alteração de preço, descrição ou fotografias deve conservar o mesmo
external_id. Numa fonte com várias agências, os IDs dos imóveis devem ser únicos em toda a fonte. - Retire do XML os imóveis indisponíveis. Após uma sincronização sem falhas e com imóveis válidos, os anúncios ausentes são desativados. Se voltarem a aparecer, podem ser reativados com o mesmo ID.
- Um feed vazio ou com erros exige revisão. Não é usado para desativar automaticamente todos os anúncios. Para retirar toda a carteira, contacte a equipa.
- Mantenha as fotografias acessíveis. Envie sempre a lista completa e ordenada de imagens de cada imóvel, com URLs estáveis. Um imóvel sem fotografias não aparece na pesquisa pública.
