HomeAdvantage Accelerate-API
HomeAdvantage System Onboarding Steps
Collection of HomeAdvantage Onboarding Data Sheet
- In the event that you want users to access the Referral Management System (RMS), a complete roster of all users (e.g., LO’s) will be required. You’ll find the required format in the onboarding sheet provided by your account manager.
- Should you opt to transmit data via the HomeAdvantage API, submission of a roster is not necessary. The developer’s API documentation below can be used for further guidance.
Typical Accelerate-API Integration Process:
- Schedule a 30-minute introductory call with the technical teams to discuss the integration process. It is suggested that the team review the documentation pages prior to the call
- Determine whether a bi-directional API will be utilized. If yes, you will need to provide their endpoint and access.
- HomeAdvantage will provide the API endpoint and key for the transmission of test data to our development environment.
- Upon successful integration, HomeAdvantage will issue a new production endpoint and key. Note, you’ll need to switch to this before launch.
Inbound API Calls (Send Data to HomeAdvantage)
Inbound API calls are pushed to HomeAdvantage’s API endpoint. These calls are typically used to retrieve information or perform operations within the HomeAdvantage platform. Examples of required data include client name and contact details; preQual information, etc. Use the link below to learn more.
Outbound API Calls (Data HomeAdvantage Sends to your System)
Outbound API calls are requests made by HomeAdvantage’s system to external systems. These calls are typically used to push data from HomeAdvantage to other platforms or services. Examples include sending updates about property status, pushing market trend data to your site, or notifying you about new listings.