API Integration with Third-Party Providers

Introduction: #

The Leadrat CRM receives leads from various third-party sources such as Magic bricks, Housing.com, Quicker Homes, Estate Dekho, Roof and Floor, Property Wala, Real Estate India, Just Lead, and Common Floor. To enable this functionality, it is essential to integrate third-party platforms with the CRM via API.Leadrat provides curl for integration which is merged in third-party applications webhook to send data in bulk to CRM. This integration facilitates seamless data exchange and transfer, enhances automation, and enables business to extend the capabilities of their CRM. By using this API, business can automate processes, synchronize data, and enhance their operational efficiency.

Perquisites: #

1. Log in to the CRM tenant using the provided credentials.
2. Ensure that the user has Admin access rights to initiate the API integration process.
3. Access global configuration settings within the CRM interface.

Integration Procedure: #

• Select desired third-party source for API integration.
• Create an account on the selected third-party platform.
• Different accounts can be created for different number of third parties.
• Create and fill in the required account details and automatically an excel file will be downloaded.
• The downloaded Excel file contains the API information like,
  1. cURL-API endpoint, API key.
  2. POST request for pushing leads to CRM.
  3. Integration manual
  4.  Authentication type
  5. Success and failure response.
  6. Parameters
  7. CRM Name
  8. Method (POST)
• Populate the Excel file with the necessary details, ensuring accuracy, and adjust parameters if required.
• Share Excel file with third-party provider as a reference for integration.
• Upon successful API integration, leads are automatically added to the CRM as per the specified parameters.
• When the parameters are hit, leads gets added to the CRM and parameters not specified are added as notes for the lead.
• Leads can be assigned to primary and secondary users within the CRM, allowing for efficient lead management.

Note: Third parties like Housing.com, Real Estate India and Just lead pull type integration is required, so we use username, password and user id for integration.

API Details: #

The API details include:

• cURL command for making HTTP requests

curl --location --request POST  https://connect.leadrat.com/api/v1/integration/EstateDekho -H "API-Key: ZXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" -H "Content-Type: application/json" -d '{
  "name": "leadname",
  "state": "leadstate",
  "city": "leadcity",
  "location": "leadlocality",
  "budget": "leadbudget",
  "notes": "comments",
  "email": "leademailid",
  "countryCode": "leadcountrycode",
  "mobile": "leadmobilenumber",
  "project": "projectname",
  "property": "propertyname",
  "leadExpectedBudget": "leadexpectedbudget",
  "propertyType": "propertytype",
  "submittedDate": "dd-mm-yyyy",
  "submittedTime": "hh-mm-ss",
  "subsource": "subsourcename",
  "leadStatus": "Schedule Site Visit or Schedule Meeting or Booked or Booking Cancel",
  "callRecordingUrl": "callrecordingURL",
  "leadScheduledDate": "dd-mm-yyyy",
  "leadScheduleTime": "hh-mm-ss",
  "bhkType": "Simplex/Duplex/PentHouse/Others",
  "leadBookedDate": "dd-mm-yyyy",
  "leadBookedTime": "hh-mm-ss",
  "additionalProperties": {
    "EnquiredFor": "Buy/Sale/Rent",
    "BHKType": "Simplex/Duplex/PentHouse/Others",
    "NoOfBHK": "0",
    "key1": "value1",
    "key2": "value1"
  }
}'

• Integration manual for reference
  CRM Integration doc for reference
• Authentication type
  API key
• Success and failure response messages
  Failure: 400 Bad Request
Success :
{
"succeeded": true,
"message": null,
"errors": null,
"data": true
}
• CRM name
  Leadrat

Summary: #

In summary, the CRM API integration with third-party providers involves configuring the CRM to interact with external APIs, enabling seamless lead capture and management from various sources. Through careful documentation and collaboration, the integration process ensures efficient data exchange and enhances the CRM’s functionality for lead tracking and conversion.