Version 3 of our REST API is now available. It is important you migrate to this version as soon as possible, especially if you have a hub in the US region and your organization has data sovereignty requirements. Continued support will be provided to those using v2 until the end of 2020.
Differences between v2 and v3
In v3 the hub identifier is no longer an integer. Instead, the hubId parameter is now of type string, which enables each hub to be identified by a unique string code instead of a numeric value.
In v2 a typical resource was identified with a url similar to /v2/hubs/1234/projects/9876, while in v3 the same resource url will be /v3/hubs/zAY4HPj0/projects/9876.
We have our BIM Track production API connected with regular services and the sandbox connected with the beta services. Please note that the beta service is not the regular BIMTrackapp services and is used to get early access to feature and API version access.
- Prod environment: https://bimtrackapp.co/
For third party software developers, once your account is created please send a request to activate with the hub name.
- Beta sandbox environment: https://bimtrackbeta.co/ (we will need your hub name to unlock all features)
The beta sandbox has separate credentials, once the account is created please send a request to firstname.lastname@example.org to activate with your hub name.
To use the BIM Track API, you must have an API access token.
Generate an API access token
Only hub owners can generate an access token for the BIM Track API.
- Log in to BIM Track.
Select the hub for which you want to create the access token.
- In the main menu on the left, select Hub Settings.
- On the Hub page, click the gear icon at the top-right, and then click API Access token. Only hub owners have access to this feature.
In the window that appears, enter your account password, accept the API agreement, and click Generate.
Your API token will be displayed. Copy it for further use in our API test page and, if necessary, communicate it securely to the person who requested it. Once it has been copied, click Close.
The token will be unavailable once the window is closed.
Only one token can be created for a hub. To generate a new one, revoke the existing token.
Perform a call
Go to our API test page at: https://api.bimtrackbeta.co//swagger/ui/index. On that page you will be able to fully test our web API functions.
- Paste your access token in the api_key box.
- Then In the URL drop-down, ensure you are using the latest version of the API and then click Explore.
- On the left side, as you scroll down or click on the main areas (File/Hub/Issue/Project) you will see the functions related to each area.
- In the middle, you have the functions/route and parameters needed and a button to test.
- On the right side, for each function, you have the response sample as well as the response schema if you click on it.
- After you have filled the mandatory fields and clicked on Try it out!, you will have your information on a modal window like this one. Please note that the throttling limit is 10 calls per second.
How do I change the viewpoint image of an issue?
Watch this video: Issue viewpoints interaction
Why am I hitting a lot of "quota-exceeded" responses?
This happens when you make more than 10 requests per second to the API. It happens most of the time when you get the data periodically.
This is a supported workflow, but we suggest you do not get the data from all the issues in all the projects in your hub since this leads to the throttling errors you are getting. Depending on how you handle these errors, this can lead to an incomplete data set.
One different approach to getting the data is to get only the issues that were created/updated since the last modified date. In order to achieve this, you could sort the data by Last Modification Date (descending order), and then stop retrieving the issues once the "last modification date" is less than the last time the query ran.
This method is much more efficient since you would be getting only a subset of the data, which in turn can be updated in your own data storage.