Integração de website e plataformas externas com o CASAFARI CRM

Atualmente, existem duas opções principais para realizar esta integração:

1. API do CASAFARI CRM

A API permite que um sistema externo comunique diretamente com o CASAFARI CRM, de acordo com os endpoints e funcionalidades disponibilizados.

A documentação técnica da API está disponível neste link.

Para ler, testar e analisar a API, deverá utilizar o seguinte token:

Authorization: Basic ZXh0ZXJuYWxkZXY6Rml0aDVmQmRmZ3NkeEhWTUF4aXpkNW9yNjhn

Com este token e URL, terá acesso a dados de teste (dummy), que poderão ser utilizados durante a fase de desenvolvimento e validação da integração.

Após concluírem esta fase e quando pretenderem passar a trabalhar com os dados reais da vossa agência, deverão enviar-nos o IP estático e dedicado do servidor que irá realizar os pedidos à API.

Iremos então validar o IP e adicioná-lo à nossa whitelist. Após esta validação, iremos disponibilizar-vos o token e a URL de produção, que permitirão o acesso aos dados reais da vossa agência.

Por que é necessário um IP estático e dedicado?

Por razões de segurança, o acesso à API de produção é permitido apenas a partir de IPs estáticos e dedicados previamente autorizados.

Isto permite-nos identificar de forma consistente a origem dos pedidos e garantir que apenas os servidores previamente validados conseguem aceder aos dados da agência.

Por este motivo, IPs dinâmicos, partilhados ou que possam ser utilizados por vários servidores não são aceites, uma vez que não permitem garantir este nível de controlo e segurança. Como tal, IPs dinâmicos e/ou partilhados  não serão adicionados à nossa whitelist.

FAQ's:

Existem limites ao número de chamadas à API ou custos adicionais associados à utilização da API de produção?

Não. Atualmente, não existem limites ao número de chamadas à API nem custos adicionais associados à utilização da ligação de produção.

É possível armazenar em cache as respostas da API no servidor para melhorar a performance do website?

Sim. É possível utilizar cache server-side para as respostas da API.

Recomendamos, por norma, um período de cache entre 15 minutos e 1 hora, dependendo das necessidades da integração. Caso a informação das propriedades não sofra alterações frequentes no vosso caso de utilização, poderá ser utilizado um período de cache superior.

Existe algum método recomendado para manter os dados das propriedades do website sincronizados com o CRM?

A abordagem recomendada depende dos endpoints utilizados e das necessidades específicas da integração.

Para websites que necessitem de manter os dados das propriedades regularmente atualizados, recomendamos a utilização dos mecanismos disponíveis na API para obter a informação mais recente, evitando pedidos repetidos para obter o conjunto completo de propriedades.

Todos os endpoints e serviços da API estão disponíveis?

Não. O acesso depende das permissões associadas ao token.

Deverá indicar-nos quais as funcionalidades de que necessita (por exemplo, consultar propriedades, criar leads ou consultar leads), para que possamos configurar as permissões adequadas.

É possível adicionar mais de um IP de produção à whitelist?

Sim. É possível adicionar até dois IPs estáticos e dedicados à nossa whitelist.

Isto permite, por exemplo, configurar um ambiente principal e um ambiente de failover, utilizando um IP dedicado para cada servidor.

2. Feed

Como alternativa à API, é possível disponibilizar um feed de propriedades através de uma URL, que poderá ser utilizado pelo sistema externo para obter os dados das propriedades.

Atualmente, estão disponíveis os seguintes formatos:

• ACME-CRM - documentação disponível neste link.

• KYERO

• XML2U

O formato mais adequado dependerá das necessidades e das capacidades técnicas do sistema que irá receber o feed.

Para a integração de leads, existem duas formas:

API - documentação disponível neste link.

Formato de Email

Para que possa receber leads de qualquer outra fonte, é essencial que seja enviado um email para: agencyname@feedcruncher.com  , de acordo com o formato abaixo:

Name:
Email:
Phone:
Origin:
Message:
Reference:

Estes campos deverão ser totalmente preenchidos e não poderão ser alterados ou traduzidos para outros idiomas.

Quando este formato for preenchido, o CRM conseguirá importar os leads e criar a origem automaticamente no sistema.

Nota: O feed é atualizado a cada 20 minutos.

Integração com WordPress

O CASAFARI CRM não disponibiliza atualmente um plugin oficial para WordPress.

Além disso, não prestamos suporte direto à configuração ou desenvolvimento de serviços externos. Isto significa que a ligação entre o website e o CASAFARI CRM não é automática.

Para que o website comunique com o CASAFARI CRM, será necessário que um programador desenvolva uma integração personalizada, utilizando a API ou o feed disponibilizado pelo CRM.

Este desenvolvimento deverá ser realizado por um programador ou equipa técnica da vossa confiança.

Não têm uma equipa técnica?

Caso não tenham uma equipa técnica interna para realizar a integração, podemos recomendar um dos nossos parceiros certificados, que estão familiarizados com o CASAFARI CRM e poderão prestar este serviço mediante uma taxa de configuração.

Qual é a melhor opção?

A escolha entre API e feed depende do objetivo da integração:

• API: indicada quando é necessária uma comunicação mais dinâmica entre o website e o CRM, ou quando é necessário criar ou consultar informação através dos endpoints disponíveis.

• Feed: indicado quando o principal objetivo é disponibilizar as propriedades do CRM num sistema externo, como um website ou portal.

O programador responsável pela integração deverá analisar os requisitos do website e determinar qual das opções é mais adequada.

Caso necessite de esclarecimentos ou suporte adicional relativamente à integração, contacte a nossa equipa através do email help@casafaricrm.com.