Overview
Using API Tokens in BoldTrail allows you to give your individual vendors the ability to integrate directly with your BoldTrail account. This is especially helpful when integrating with an outside lead source and having those new leads flow directly into BoldTrail. You can also use it to push your profile information and subdomain to an outside vendor as well.
Please Note: You will need to work closely with your vendor in order to properly utilize an API Token. BoldTrail provides you with up to three tokens to use, but your vendor will need to set the integration up on their end. Inside Real Estate cannot assist with this.
Generating an API Token
In order to generate a token you will first log into your BoldTrail account.
Click 'Lead Engine' from the main navigation.
Click on 'Lead Dropbox'.
You may have to scroll down in order to see the 'My API Tokens' box.
Check the box for the type of token you need: Contacts or User.
If necessary, select 'All' to generate an all scopes token
Click Generate.
Please Note: The 'All' feature will allow full access to the V2 API for the external partner using the API.
Once the token has been generated your page will automatically refresh and the token will appear at the top of the 'My API Tokens' box.
You can then copy the token and provide it to your desired vendor for them to set up the integration. Each token will remain active for a year from the date it was generated. At the end of the year, you will need to generate a new token and provide that to your vendor so they can switch the original for the new one.
The 'Contacts; option will allow them to sync your contact data from BoldTrail to their system and sync your contact data from their system to BoldTrail.
The 'User' option will allow them to pull your user profile data and subdomain into their system.
Deleting an API Token
In order to delete a token simply navigate back to Lead Dropbox and click on the 'x' option to the right of the token.
Please Note: This is a "soft delete" of the token, meaning the token will be removed from your limit of three while still remaining active. You will need to work with your vendor to remove the token from their system.
TIP: If you need to generate more than three tokens you can soft delete one and generate a new token. Simply click the "x" button to the right of the token and confirm you would like to delete it. Deleted tokens will still remain active for a year so you can generate the token, save it outside of BoldTrail, and then delete it to make room for more tokens.
Using an API Token
Different vendors will work with API Tokens differently and some may not use them at all, so you will need to speak with them in order to confirm if passing data to or from BoldTrail and your vendor's system is a viable option.
The API Token allows for existing data from your vendor to be pushed into BoldTrail, but your vendor will need to set this up along with the trigger for passing new data through.
Currently, there is no way to push or pull more data fields than those that are already listed:
Contacts - send/receive contacts data (name, email, phone, etc...)
Users - send/receive profile information (name, email, signature) and website subdomain
If you believe there is an issue with the data your token is passing through, please contact your vendor to confirm that it is still active on their end.
Developer Portal
The Inside Real Estate Developer Portal is the ultimate destination for seamless API integration and effortless development. This comprehensive new platform will revolutionize the way developers access and utilize APIs, empowering your third-party integration partners and internal development team to execute API integrations seamlessly, and faster than ever before.
The developer portal includes:
Clear and concise documentation - Consolidated API documentation that provides clear explanations, detailed guides, playbooks, and comprehensive references.
An interactive experience - Users can interact with the API directly from the portal without needing to leverage any other site or tool. Create, update, remove offices or teams, add users, add manual listings, and more, all with the click of a button!
A place of collaboration - The discussion board nurtures learning, growth, and partnership among users.
Frequently Asked Questions
How can our team access the Inside Real Estate Developer Portal?
The website is publicly accessible, simply click the following link: developer.insiderealestate.com
Who should know about this?
Your third-party developer partners - any partner applications that can build integrations within BoldTrail
Your internal developers - anyone on your internal teams responsible for building integrations within BoldTrail
What should I do next?
Share the Portal URL with your partners
Have applicable partners and/or developers dive into our comprehensive overview, “Getting Started”
Share the Video Overview for feature highlights
Have questions about the developer portal?
Our dedicated team is here to assist, and to ensure your partners and internal teams feel supported and empowered to leverage this powerful new tool. Email any questions to: developersupport@insiderealestate.com.
Have more questions? Please reach out to Customer Support via the blue chat bubble to the right or by emailing support@insiderealestate.com!