Articles sur : Outils et interfaces
Cet article est aussi disponible en :

API openCDE de buildagil


Possibilités

L'API openCDE de buildagil permet une interaction fluide avec buildagil et offre de nombreuses fonctions et outils destinés à faciliter l'échange de données et l'intégration dans les systèmes existants. Elle repose sur la spécification de l'API openCDE de BuildingSMART (API BCF / API Documents) et a été enrichie de points de terminaison, de possibilités et de champs supplémentaires afin d'offrir davantage de flexibilité et de fonctionnalités.


L'API openCDE de buildagil offre notamment les possibilités suivantes :

  • Rechercher du contenu
  • Consulter, créer et modifier des tâches personnelles
  • Consulter les informations relatives au projet
  • Consulter, créer et modifier des tâches et des sujets
  • Consulter, télécharger, déplacer et modifier des documents
  • Consulter les versions des documents
  • Consulter et modifier les métadonnées des documents
  • Consulter les réunions
  • Consulter les jalons
  • Afficher les utilisateurs
  • Réagir à la création de tâches et de sujets, de documents, de réunions, de jalons et d'utilisateurs
  • Réagir aux modifications apportées aux tâches et aux sujets, aux documents, aux réunions et aux jalons


Vous trouverez la documentation OpenAPI de l'API buildagil openCDE via le lien suivant : Documentation OpenAPI


Authentification

Pour vous authentifier auprès de l'API buildagil openCDE, veuillez contacter le service d'assistance en indiquant une URL de rappel afin d'obtenir l'identifiant client (Client ID) et la clé secrète client (Client Secret). Ces informations d'identification sont nécessaires pour vous authentifier auprès de l'API buildagil openCDE.


L'authentification repose sur la plateforme d'identité Microsoft et s'effectue via le flux de code d'autorisation OAuth 2.0 avec connexion par utilisateur. Chaque connexion est associée à un utilisateur unique. Pour plus d'informations sur le flux de code d'autorisation, consultez l'article suivant : Plateforme d'identité Microsoft et flux d'autorisation OAuth 2.0.


Visibilité et autorisations

La consultation et la modification de contenus via l'API openCDE de buildagil sont soumises aux mêmes règles de visibilité et aux mêmes autorisations que celles en vigueur sur buildagil. Vous trouverez plus de détails à ce sujet sous Visibilité et autorisations.


Environs

L'API buildagil openCDE n'est disponible que dans un environnement de production.


Limites de débit

L'API openCDE de buildagil utilise une limitation de débit dynamique basée sur l'utilisateur. En cas d'utilisation intensive, il peut arriver que celle-ci soit réduite en fonction de l'utilisateur. Il est recommandé d'effectuer les opérations volumineuses (telles que la récupération ou le téléchargement de grandes quantités de données) aux heures creuses.


Liens profonds

Pour ouvrir directement des contenus sur buildagil ou y renvoyer, il est possible d'utiliser la propriété « link » dans la réponse correspondante.


Conditions d'utilisation

L'API est mise à disposition aux fins décrites ci-dessus, conformément au principe d'utilisation équitable. Certaines fonctions, structures de données, points de terminaison ainsi que des restrictions techniques ou liées à l'utilisation peuvent être adaptées ou modifiées dans le cadre du développement ultérieur. Les modifications prévues et mises en œuvre seront publiées dans le Actualités et mises à jour.


Les utilisateurs et utilisatrices de l'API sont responsables de la conservation sécurisée des identifiants et des jetons, ainsi que de l'utilisation conforme de l'API. Les mécanismes de sécurité, les restrictions d'accès et les limites de débit ne doivent pas être contournés. Les utilisateurs sont en outre tenus de vérifier de manière appropriée les données obtenues via l’API. Ils sont également responsables de toutes les actions déclenchées via l’API, que celles-ci soient effectuées directement, de manière automatisée ou par des applications tierces, y compris des agents d’intelligence artificielle.


Par ailleurs, les dispositions Conditions générales d'utilisation de buildagil s'appliquent.


openCDE, OpenAPI, API, API BCF, OAuth 2.0, flux de code d'autorisation, plateforme d'identité Microsoft, connexion basée sur l'utilisateur, ID client, secret client, environnement de production, environnement de test, authentification API

Mis à jour le : 23/10/2026