API di Altium 365
L'API di Altium 365 è un'API GraphQL che offre accesso programmatico ai dati del tuo Workspace Altium 365. Supporta operazioni sia di lettura sia di scrittura su tutta la piattaforma.
Come è organizzata l'API
L'API è strutturata attorno alle aree di dominio della piattaforma, note come bounded contexts. Ogni contesto delimitato copre un'area specifica della piattaforma, con le relative entità, operazioni e regole di business. I nomi dei tipi e delle query GraphQL seguono convenzioni di denominazione che riflettono l'area di dominio a cui appartengono, rendendo più semplice navigare nello schema una volta acquisita familiarità con la struttura.
Principali contesti delimitati
Contesto delimitato |
Ambito coperto |
Design |
Progetti PCB, schemi elettrici, varianti, rilasci, pacchetti di produzione |
Library |
Componenti, simboli, footprint, parti, richieste di parti, schede tecniche |
Procurement |
Distinte base, voci della distinta base, parti alternative e sostitutive |
Platform |
Utenti, Workspace, organizzazioni, definizioni del ciclo di vita, denominazione delle revisioni |
Collaboration |
Commenti, thread di commenti, attività |
Customization |
Flussi di lavoro, script, esecuzioni di script |
Altri contesti delimitati coprono funzionalità più specializzate: modellazione dei dispositivi, aggiornamenti firmware over-the-air, gestione dei requisiti, software embedded e progettazione di sistemi. Sono accessibili tramite la stessa API e seguono le stesse convenzioni.
Ogni contesto delimitato avrà una sezione dedicata nella documentazione man mano che la copertura verrà ampliata. Nel frattempo, il browser dello schema Voyager integrato è un ottimo strumento per esplorare il grafo completo dei tipi.
Endpoint
Endpoint regionali
Usa un endpoint regionale quando non stai operando su un Workspace specifico, ad esempio per elencare tutti i Workspace a cui un utente ha accesso, oppure quando lavori con dati globali come utenti e organizzazioni.
Regione |
GraphQL |
Servizio file |
Voyager (esplorazione dello schema) |
Europa |
|
|
https://eur.365.altium.com/api/voyager |
Stati Uniti occidentali |
|
|
https://usw.365.altium.com/api/voyager |
Stati Uniti orientali |
|
|
https://use.365.altium.com/api/voyager |
Asia Pacifico |
|
|
https://asp.365.altium.com/api/voyager |
GovCloud |
|
|
https://use.365-gov.altium.com/api/voyager |
Endpoint del Workspace
Gli endpoint del Workspace sono il punto di partenza consigliato per interagire con le risorse specifiche di un Workspace. Gli endpoint API utilizzano lo stesso dominio del Workspace e possono essere individuati a livello programmatico: consulta l'esempio Elencare i Workspace.
GraphQL |
Servizio file |
Voyager (esplorazione dello schema) |
|
|
https://{workspace-domain}/api/voyager |
Esplorazione dello schema
L'API di Altium 365 è autodocumentante. Due strumenti integrati sono disponibili direttamente dall'URL del tuo Workspace:
-
Nitro – un IDE GraphQL basato su browser per scrivere ed eseguire query in modo interattivo:
https://{workspace-domain}/api/graphql/ -
Voyager – un grafo visivo dello schema completo, utile per comprendere le relazioni tra i tipi:
https://{workspace-domain}/api/voyager/
Autenticazione
Tutte le richieste devono includere un token di accesso valido:
Authorization: Bearer {access-token}
Consulta Utilizzo di un token di accesso per maggiori dettagli.
In questa sezione
Localizzato tramite A