Knowledge base

API/Developer documentation website

Steel

Concrete

v25.1

v23.1

This article is also available in:

Why create a website about the IDEA API? In response to market demand for more information about how to connect and tailor-make data interconnections, BIM link creators, design automation tool developers, and visual programming experts can find all necessary information and documentation there.

Where can you find it?

The page developer.ideastatica.com is the place to go.

This new developer documentation site gives IDEA StatiCa third-party developers and API scripters a single access point for information relating to IDEA StatiCa public services and code.

The site links together static documentation, code documentation, and specific examples.

Improvements compared to the previous system

The public GitHub web page provides a lot of useful information but may not be that easy to navigate. Therefore, this provides developers with a single access point.
Breaking change release notes help notify developers when and how they need to update their third-party apps.
Provides a distinction between public WIP developments (should not be used as products) and those that are working products with documentation.
The Wiki provides the ability to create code documentation and tie it to classes and concepts.
The Wiki stays automatically updated and maintained.
Examples are easily accessible from the documentation.

The site is split into four distinct sections:

IDEA Open Model (IOM), related to the creation and specification of the IOM Data model.
BIM Links (BIM API), related to the creation of Checkbot BIM Links using the BIM API framework.
Design API (API), related to Design App APIs.
Extensions, related to Extensions created on top of the design app APIs.