BIM 360 Enterprise Account Administration (or HQ for short) has a feature to control API access for HQ. I have described about this in my earlier post. As a part of recent update, this feature was extended to include the control over API access to Docs. The owner of Docs account can now activate API access to Docs and invite a developer to grant API access.
Important: Currently (as of January 19, 2017), the API access to Docs is in preview mode. Please do not use with your production data. You should have read access to project data. However, the documentation is still to come. We don’t recommend to try complex access, such as write access, till the proper workflow is documented and made available. (Update: 2/6/2017 – upload is possible now (y). Please refer to this post.)
(Note: HQ API is ready for production use. Because of Docs access, the 3rd tab still says preview. But it has been used in production.)
Also, the access to the API is limited to the owner of following license types:
- BIM 360 Enterprise account
- NFR (Not for Resale) version that the member of ADN (Autodesk Developer Network) can order for development purpose (*1)
Trial version, for example, won’t give you an access to API. So be aware.
*1) ADN member can find “Development Software and Web Services Request Form” from the upper right pane on the main page of ADN extranet (http://adn.autodesk.com).
Activate API Access
Below is the step-by-step instruction to activate API access to BIM 360 HQ and Docs. (The steps are the same as described on the product’s help page. But below includes images for additional clarity.)
- Log into your BIM 360 Enterprise: https://bim360enterprise.autodesk.com/
- If you have more than one account, choose one you want to integrate your application.
- Go to Account Settings menu (“gear” icon on the left. See the image below).
- You should see “Apps & Integrations” tab (the third one) if you are the account owner of license types mentioned above.
5. Click on “Add Integration” button to register your app for the specific account. “Add Integration” dialog appears (image below).
Choose the APIs you want to have an access: HQ and/or Docs. Click “Next”.
6. You will be presented with a dialog where you can specify whom you want to give an access to API:
- “I’m the developer” — If you are using API yourself, choose this one.
- “Invite a developer” — If you want to invite a 3rd party developer, choose this.
Here we’m choosing the first one, “I’m the developer”. Click “Next”. (An example of “Invite a developer” comes later in this post.
7. The form to fill in App information like shown below appears. In the form, fill in the information. The key information here is your Forge Client ID.
You can obtain Forge Client ID from developer.autodesk.com portal >> My Apps. If you haven’t created/registered your app, or if you are not familiar with Client ID yet, please refer to this page for more information: “Create an App” .
Finally, click “Save.”
You will see a brief message saying that your app is active.
You have now activated API access to Docs! You can use your app (or your app’s client ID) to access Docs data.
Invite 3rd Party
The above sequence shows you as the developer. If you are not a developer yourself and have a 3rd party developer writing code you, or you want to integrate an app written by the 3rd party developer, you can invite them to give an access to your data.
In the step 6 above, choose “Invite a developer.” Enter the e-mail address of the developer that you want to invite (image below).
When you click “Send”, the system will send an e-mail like below to the address you entered:
When the developer receives the invitation e-mail and click “Get Started”, the developer will be directed to the same form shown on the step 7 above. The developer can then fill necessary information, such as Forge Client ID. The difference from “I’m the developer” is that, after the form is filled in, it won’t go to the account owner’s Account Setting page.
Finally, the account owner approve the app that the developer entered by clicking the “Approve” button in the “Apps & Integrations” tab (the image below).
Then, the app becomes “Active”.
If you have successfully gone through the above, you or your developer is ready to use API now. (Stay tuned for more posts…)