If you have purchased API access with your BC Pro subscription, you can generate or delete your company’s API credentials within your account.
If you are interested in API access and do not have this feature in your account, the API is an added paid service with BC Pro. Please contact your company’s Account Executive or Customer Success Manager to discuss.
To generate your company’s API credentials
Click on the person icon on the left-hand menu and click on the "Account" tab.
In the “Other” section, click “Generate API credentials”.
- API capabilities must be turned on for your company. If you don't see the button, please contact your Account Executive or Customer Success Manager.
- You must be an Office Lead to generate API credentials. If you are not an Office Lead, the button will be greyed out. You can learn more about office leads and how to find them here.
Click "Generate API credentials" in the pop-up window.
Your credentials will be generated in the pop-up window. Click to “Copy client id” and “Copy client secret” and paste them in your records. Lost credentials cannot be recovered.
Please refer to the BuildingConnected API documentation to learn more about how to use your credentials.
Once generated, the page will show your client_id, who generated the credentials, and when they were generated.
To delete your company’s API credentials
If you lose your credentials or need to reset them for any reason, you must first delete the existing credentials and recreate them.
You must be an Office Lead to delete API credentials. If you are not an Office Lead, the button will be greyed out. You can learn more about office leads and how to find them here.
Click “Delete API credentials” on the “Account” settings page.
IMPORTANT: Deleting your API credentials will break all current API connections for everyone in your company. The information can be retrieved if new credentials are generated, but your connections will not work while the API credentials are deleted.
Type “DELETE” to confirm and click “Delete API credentials”.
The page will show who deleted the most recent credentials and when it was deleted.
If you are resetting your credentials, you can proceed to click “Generate API credentials” and reference the instructions at the beginning of this article.