Preparing your API Integration

Published on January 27, 2022

  You want to get a head start on preparing your API Integration with Hivebrite? 

    Please consider the following questions:

  • Which system will be the "source of truth" - housing official data?
  • What is the name of the system where the data will be stored in addition to Hivebrite?
  • What data points will be transferred from Hivebrite to your other system/ or from the other system to Hivebrite?
  • Do you need to create any additional custom fields that don't already exist in Hivebrite?
  • What is your business process?
    • Which direction will the data flow?
    • From your other system, (i.e CRM) to Hivebrite?
    • From Hivebrite to your CRM? Will the data flow both ways?
    • What will trigger this process?
    • What are the read/write rules or the business rules needed?

 

NOTE:

- Hivebrite offer data import and export via Excel to all customers. 
- Data Integration via API is available included in our Premier and Enterprise packages and can be purchased as an Add-On with the Pro package.
Public documentation on all available endpoints can reviewed here https://hivebrite.com/documentation/api/admin
- Sandbox environments to test API integrations are included in the Enterpise Package and can be purchased as an Add-On with the Premier package.