BIMcollab offers three types of developer options: the BIMcollab API, the BIMcollab SDK, and file specifications. This article explains what each option does, so you can choose the right one before you start building.
💡 Tip: New to APIs or SDKs? Read API and SDK basics for beginners first.
What you can build
With these options, your integration or application can work directly with BIMcollab data. Common examples:
Issue synchronization: keep issues in your own system and in BIMcollab aligned.
Automatic publishing: send models, drawings, or reports from your own system straight to BIMcollab.
Bulk upload: upload many files at once instead of one by one.
Reporting and dashboards: read project, issue, or document data to feed your own reports.
BIM tool integration: add a complete BCF Manager to your own BIM application.
Smart Views from your standards: generate Smart Views for BIMcollab Zoom from your own software or company standards.
BIMcollab developers options
BIMcollab API
The BIMcollab API consists of two REST APIs. You use them to send requests and receive data in JSON format. You build your own user interface.
Connection API: read and manage issue data. It is an extended version of the open BCF-API standard by buildingSMART and supports all BIMcollab issue fields, including custom fields.
Documents API: read and manage files in a BIMcollab space. It supports the most common document management actions and gives access to To-do data.
BIMcollab SDK
Connector with full GUI: a C# library that includes a complete user interface, similar to the BIMcollab BCF Managers. Embed it in your Windows application and add functions to connect it to your model viewer, such as finding components, setting the camera position, and taking snapshots.
💡 Tip: We recommend the SDK when you want to add BIMcollab issue management to a BIM tool, without designing your own interface.
File specifications
Some BIMcollab Zoom files use a documented format. Your software can create these files, and users import them into BIMcollab Zoom. You don't need a connection to BIMcollab, credentials, or access to the Playground.
Smart View files (.bcsv): XML files that describe Smart View sets and Smart Views. Generate them from your own software or company standards, and import them into BIMcollab Zoom to share them with your team.
💡 Tip: We recommend a file specification when you want to create BIMcollab Zoom content automatically, without building a live integration.
Compare the options
| Connection API | Documents API | BIMcollab SDK | Smart View files (.bcsv) |
Type | BIMcollab API | BIMcollab API | BIMcollab SDK | File specification |
Data | Issues (BCF) | Files, documents and To-dos | Issues (BCF) | Smart Views and Smart View sets |
User interface included | No | No | Yes | No. The file is used in BIMcollab Zoom. |
Platform | Any | Any | Windows only | Any |
Language | Any language that sends HTTP requests | Any language that sends HTTP requests | C# (.NET Framework 4.8) | Any language that can write XML |
Authentication | OAuth 2.0 | OAuth 2.0 | App token and BIMcollab ID | None |
Typical use | Sync issues with your own app or platform | Automate document uploads and reporting | Add a BCF Manager to your BIM application | Generate Smart Views from your software or standards |
Which option should I choose?
You want to work with issues in your own application or on a server
→ use the Connection API.You want to upload, read, or update documents, or read To-do data
→ use the Documents API.You want a ready-made issue interface inside your own Windows BIM application
→ use the BIMcollab SDK.You want to create Smart Views for BIMcollab Zoom automatically
→ use Smart View files (.bcsv).
📝 Note: You can also combine options. For example, an application can use the Connection API for issues and the Documents API for files.
How to get started
Select the right option: Define your integration requirements and use our comparison table to choose the right tool.
Get access to the Playground: The Playground is our development space for testing. See Developing on the Playground and moving to production.
Set up authorization:
For the BIMcollab API, see How to authenticate with the BIMcollab API.
For the BIMcollab SDK, see SDK Connector with full GUI: overview and requirements.
Make your first request: Follow Getting started with the Connection API or Getting started with the Documents API.
Move to production: When your application works on the Playground, request your own client credentials to connect to your private space.
📝 Note: Steps 2 to 5 apply to the BIMcollab API and the BIMcollab SDK. Working with File specifications doesn't require the Playground or credentials. To start creating Smart Views, see Generating Smart Views with .bcsv files.
💡 Tip: If you are starting to work with APIs, take a look at our article API and SDK basics for beginners to learn the fundamental concepts.