Website and External Platform Integration with CASAFARI CRM

Currently, there are two main options for setting up this integration:

1. CASAFARI CRM API

The API allows an external system to communicate directly with CASAFARI CRM, according to the available endpoints and functionalities.

The API technical documentation is available at this link.

To read, test and analyse the API, you should use the following token:

Authorization: Basic ZXh0ZXJuYWxkZXY6Rml0aDVmQmRmZ3NkeEhWTUF4aXpkNW9yNjhn

With this token and URL, you will have access to test (dummy) data, which can be used during the development and integration validation phase.

Once you have completed this phase and are ready to work with your agency's real data, you will need to provide us with the static and dedicated IP address of the server that will make the API requests.

We will then validate the IP address and add it to our whitelist. Once this validation is complete, we will provide you with the production token and URL, which will allow access to your agency's real data.

Why is a static and dedicated IP required?

For security reasons, access to the production API is only allowed from previously authorised static and dedicated IP addresses.

This allows us to consistently identify the origin of API requests and ensure that only previously validated servers can access the agency's data.

For this reason, dynamic or shared IP addresses, or IPs that may be used by multiple servers, are not accepted, as they do not provide the same level of control and security. Therefore, dynamic and/or shared IP addresses will not be added to our whitelist.

FAQs

Are there any API call limits or additional costs associated with using the production API?

No. At the moment, there are no API call limits or additional costs associated with the production connection.

Can API responses be cached server-side to improve website performance?

Yes. API responses can be cached server-side.

As a general recommendation, we suggest a cache period between 15 minutes and 1 hour, depending on the requirements of the integration. If property information does not change frequently in your specific use case, a longer cache period may also be used.

Is there a recommended method for keeping website property data synchronised with the CRM?

The recommended approach depends on the endpoints being used and the specific requirements of the integration.

For websites that need to keep property data regularly updated, we recommend using the available API mechanisms to retrieve the latest information, avoiding repeated requests for the complete property dataset.

Are all API endpoints and services available?

No. Access depends on the permissions associated with the token.

You should let us know which functionalities you require (for example, accessing properties, creating leads or accessing leads), so that we can configure the appropriate permissions.

Can more than one production IP address be added to the whitelist?

Yes. Up to two static and dedicated IP addresses can be added to our whitelist.

This allows, for example, a primary and failover environment to be configured, using a dedicated IP address for each server.

2. Feed

As an alternative to the API, it is possible to provide a property feed via URL, which can be used by the external system to retrieve property data.

The following formats are currently available:

• ACME-CRM – documentation available at this link.
• KYERO
• XML2U

The most appropriate format will depend on the requirements and technical capabilities of the system receiving the feed.

Lead integration

There are two options for integrating leads:

• API – documentation available at this link.
• Email format

To receive leads from any other source, an email must be sent to agencyname@feedcruncher.com, using the following format:

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

These fields must be fully completed and cannot be changed or translated into other languages.

When this format is used, the CRM will be able to import the leads and automatically create the corresponding source in the system.

Note: The feed is updated every 20 minutes.

WordPress Integration

CASAFARI CRM does not currently provide an official WordPress plugin.

In addition, we do not provide direct support for the configuration or development of external services. This means that the connection between the website and CASAFARI CRM is not automatic.

For the website to communicate with CASAFARI CRM, a developer will need to build a custom integration, using either the API or the feed provided by the CRM.

This development should be carried out by a developer or technical team of your choice.

Don't have a technical team?

If you do not have an internal technical team to carry out the integration, we can recommend one of our certified partners, who are familiar with CASAFARI CRM and can provide this service for a configuration fee.

Which option is best?

The choice between API and feed depends on the purpose of the integration:

• API: recommended when a more dynamic communication between the website and the CRM is required, or when it is necessary to create or retrieve information through the available endpoints.

• Feed: recommended when the main purpose is to make CRM property data available to an external system, such as a website or portal.

The developer responsible for the integration should assess the website requirements and determine which option is most suitable.

If you need any clarification or additional support regarding the integration, please contact our team at help@casafaricrm.com.