Base théorique

Site web de documentation de l'API/du développeur

Steel

Concrete

v25.1

v23.1

Cet article est aussi disponible en :

Pourquoi un site web sur l’API IDEA ? Pour répondre à la demande du marché d’informations sur la connexion et l’adaptation des données. Les développeurs, créateurs de liens MIB et experts en automatisation y trouvent toute la documentation nécessaire.

Où le trouver ?

La page developer.ideastatica.com est l'endroit où vous devez aller.

Ce nouveau site de documentation pour les développeurs offre aux développeurs tiers d'IDEA StatiCa et aux scripteurs d'API un point d'accès unique aux informations relatives aux services publics et à la norme d'IDEA StatiCa.

Le site relie la documentation statique, la documentation de la norme et des exemples spécifiques.

Améliorations par rapport au système précédent

La page web publique de GitHub fournit de nombreuses informations utiles, mais il n'est pas toujours facile d'y naviguer. C'est pourquoi ce système offre aux développeurs un point d'accès unique.
Les notes de mise à jour sur les ruptures permettent aux développeurs de savoir quand et comment ils doivent mettre à jour leurs applications tierces.
Il permet de faire la distinction entre les développements WIP publics (qui ne devraient pas être utilisés comme des produits) et ceux qui sont des produits fonctionnels accompagnés d'une documentation.
Le Wiki permet de créer une documentation sur la norme et de la relier aux classes et aux concepts.
Le Wiki est automatiquement mis à jour et entretenu.
Les exemples sont facilement accessibles à partir de la documentation.

Le site est divisé en quatre sections distinctes :

IDEA Open Model (IOM), relatif à la création et à la spécification du modèle de données IOM.
Liens MIB (MIB API), relatifs à la création de liens MIB Checkbot à l'aide du cadre MIB API.
Design API (API), relatif aux API des applications de conception.
Extensions, relatives aux extensions créées à partir des API de l'application de conception.