Articoli su: Strumenti e interfacce
Questo articolo è disponibile anche in:

Buildagil API openCDE


Possibilità

L'API openCDE di buildagil consente un'interazione fluida con buildagil e offre numerose funzioni e strumenti per facilitare lo scambio di dati e l'integrazione nei sistemi esistenti. Si basa sulla specifica API openCDE di BuildingSMART (BCF API / Documents API) ed è stata ampliata con endpoint, opzioni e campi aggiuntivi per offrire maggiore flessibilità e funzionalità.


L'API openCDE di buildagil offre, tra le altre cose, le seguenti funzionalità:

  • Cerca contenuti
  • Visualizzare, creare e modificare incarichi personali
  • Visualizzare le informazioni sul progetto
  • Visualizzare, creare e modificare incarichi e temi
  • Recuperare, caricare, spostare e modificare documenti
  • Richiedere le versioni dei documenti
  • Recuperare e modificare i metadati dei documenti
  • Visualizzare le riunioni
  • Visualizza i traguardi fondamentali
  • Recupera utente
  • Rispondere alla creazione di incarichi e temi, documenti, riunioni, traguardi e utenti
  • Reagire alle modifiche relative agli incarichi e ai temi, ai documenti, alle riunioni e ai traguardi


La documentazione OpenAPI dell'API buildagil openCDE è disponibile al seguente link: Documentazione OpenAPI


Autenticazione

Per l'autenticazione all'API buildagil openCDE, si prega di contattare l'assistenza indicando un URL di callback per ricevere l'ID client e il segreto client. Queste credenziali sono necessarie per autenticarsi all'API buildagil openCDE.


L'autenticazione si basa sulla Microsoft Identity Platform e avviene tramite il flusso di autorizzazione OAuth 2.0 con accesso basato sull'utente. Ogni accesso è associato a un singolo utente. Per ulteriori informazioni sul flusso di autorizzazione tramite codice, consultare il seguente articolo: Piattaforma di identità Microsoft e flusso di autorizzazione OAuth 2.0.


Visibilità e autorizzazioni

Per il recupero e la modifica dei contenuti tramite l'API openCDE di buildagil si applicano le stesse impostazioni di visibilità e autorizzazioni previste su buildagil. Maggiori dettagli sono disponibili all'indirizzo Visibilità e autorizzazioni.


Dintorni

Per l'API buildagil openCDE è disponibile esclusivamente un ambiente di produzione.


Limiti di frequenza

L'API openCDE di buildagil utilizza un sistema di limitazione della velocità dinamico basato sull'utente. In caso di utilizzo elevato, è possibile che tale velocità venga limitata in base all'utente. Si raccomanda di eseguire operazioni di ampia portata (come ad esempio il recupero o il caricamento di grandi quantità di dati) nelle ore di minor traffico.


Deep linking

Per aprire direttamente i contenuti su buildagil o per rimandarvi, è possibile utilizzare la proprietà "link" nella rispettiva risposta.


Condizioni d'uso

L'API viene messa a disposizione per gli scopi sopra descritti secondo il principio del "fair use". Singole funzioni, strutture di dati, endpoint e limitazioni tecniche o relative all'utilizzo possono essere adattate o modificate nell'ambito dell'ulteriore sviluppo. Le modifiche pianificate e attuate saranno pubblicate nel Novità e aggiornamenti.


Gli utenti dell’API sono responsabili della conservazione sicura delle credenziali di accesso e dei token, nonché dell’uso corretto dell’API. Non è consentito eludere i meccanismi di sicurezza, le restrizioni di accesso e i limiti di frequenza. Gli utenti sono inoltre tenuti a verificare adeguatamente i dati ricevuti tramite l’API. Sono inoltre responsabili di tutte le azioni attivate tramite l’API, indipendentemente dal fatto che queste siano avviate direttamente, in modo automatizzato o tramite applicazioni di terze parti, inclusi gli agenti di intelligenza artificiale.


Si applicano le Condizioni generali di utilizzo di buildagil.


openCDE, OpenAPI, API, BCF API, OAuth 2.0, flusso del codice di autorizzazione, Microsoft Identity Platform, accesso basato sull'utente, ID client, segreto client, ambiente di produzione, ambiente di test, autenticazione API

Aggiornato il: 22/10/2026