The Playground is the BIMcollab development space. Use it to build and test your integration with the BIMcollab API before you work with real project data. This article explains how to get access to the Playground and how to get production credentials when your application is ready.
Why use the Playground?
A production space contains real project data that teams use every day. A mistake during testing, such as deleting issues or uploading test files, can disrupt their work.
The Playground lets you:
Test requests without affecting real projects.
Use shared credentials, so you can start right away.
Make mistakes safely while you learn how the API works.
⚠️ Attention: Don't develop or test your application in a production space. Make sure your application works well on the Playground first.
Get access to the Playground
Setting up access is a one-time process.
Apply for a developer account. Fill in the developer application form. We add your account to the Playground space.
Set your password. After you are added, set a password for your BIMcollab user account on the Playground. You sign in with this account when your application requests access.
Note the Playground credentials. Use the shared Playground credentials to authorize your application. You can find them in Authorization for the Connection API and Documents API.
Test your integration
When you have access, follow these steps:
Get an access token. See Authorization for the BIMcollab API.
Make your first request:
For issues, see Getting started with the Connection API.
For documents, see Getting started with the Documents API.
Test all the actions your application will perform, including errors. For example, check what happens when a token expires or when you reach a rate limit.
💡 Tip: Use clearly named test data, such as projects and issues that start with TEST. This makes it easy to find and clean up your data later.
Request client credentials
When your application works on the Playground, you can request your own client credentials.
The process is the same for the Connection API and the Documents API.
Send an email to [email protected]. Include:
Type of implementation: private (server-to-server) or commercial.
Callback URL(s): the address(es) your application uses.
BIMcollab spaces: the spaces your application needs to connect to.
You receive a Client ID and client secret for your application.
Replace the Playground credentials in your application with your production credentials.
⚠️ Attention: BIMcollab checks the Client ID, callback URL, and scope together. Use them exactly as provided. If you need a different callback URL, request it. Don't change it in your application only.
Keep your credentials safe
Store your client secret on a server or in a secure configuration file. Don't put it in code that users can see, such as a web page or a public repository.
Don't share access tokens or refresh tokens.
If you think your client secret is exposed, contact us right away.