Kennisbank

API/Developer-documentatiewebsite

Steel

Concrete

v25.1

v23.1

Dit artikel is ook beschikbaar in:

Waarom een website over de IDEA API? Als antwoord op de vraag uit de markt naar meer informatie over het koppelen en op maat maken van data-interconnecties, kunnen BIM-koppelingmakers, ontwikkelaars van APIs en experts in visueel programmeren hier alle benodigde informatie en documentatie vinden.

Waar kun je het vinden?

De pagina developer.ideastatica.com is de plek om naartoe te gaan.

Deze nieuwe ontwikkelaarsdocumentatiesite geeft IDEA StatiCa third-party ontwikkelaars en API scripters een enkel toegangspunt voor informatie met betrekking tot IDEA StatiCa publieke diensten en code.

De site koppelt statische documentatie, codedocumentatie en specifieke voorbeelden aan elkaar.

Verbeteringen ten opzichte van het vorige systeem

De publieke GitHub webpagina biedt veel nuttige informatie, maar is niet altijd even gemakkelijk te navigeren. Daarom biedt dit ontwikkelaars één toegangspunt.
Breaking change release notes helpen ontwikkelaars te melden wanneer en hoe ze hun apps van derden moeten updaten.
Biedt een onderscheid tussen openbare WIP-ontwikkelingen (mogen niet worden gebruikt als producten) en die welke werkende producten zijn met documentatie.
De Wiki biedt de mogelijkheid om codedocumentatie te maken en deze te koppelen aan klassen en concepten.
De Wiki wordt automatisch bijgewerkt en onderhouden.
Voorbeelden zijn gemakkelijk toegankelijk vanuit de documentatie.

De site is opgedeeld in vier verschillende secties:

IDEA Open Model (IOM), met betrekking tot het maken en specificeren van het IOM-datamodel.
BIM Links (BIM API), met betrekking tot het aanmaken van Checkbot BIM Links met behulp van het BIM API framework.
Design API (API), met betrekking tot Design App API's.
Extensies, gerelateerd aan Extensies die zijn gemaakt bovenop de ontwerp-Appi's.