API di Altium 365
L'API di Altium 365 è un'API GraphQL che fornisce accesso programmatico ai dati del tuo Workspace Altium 365. Supporta sia operazioni di lettura che di scrittura su tutta l'ampiezza della piattaforma.
Come è organizzata l'API
L'API è strutturata intorno alle aree di dominio della piattaforma, note come bounded contexts. Ogni bounded context copre un'area specifica della piattaforma: le sue 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 orientarsi nello schema una volta acquisita familiarità con la struttura.
Principali bounded context
Bounded Context |
Cosa comprende |
Design |
Progetti PCB, schemi, varianti, release, pacchetti di produzione |
Library |
Componenti, simboli, footprint, parti, richieste di parti, datasheet |
Procurement |
Distinte base, voci BOM, parti alternative e sostitutive |
Platform |
Utenti, Workspace, organizzazioni, definizioni del ciclo di vita, denominazione delle revisioni |
Collaboration |
Commenti, thread di commenti, attività |
Customization |
Workflow, script, esecuzioni di script |
Ulteriori bounded context coprono funzionalità più specializzate – modellazione dei dispositivi, aggiornamenti firmware over-the-air, gestione dei requisiti, software embedded e progettazione di sistema. Sono accessibili tramite la stessa API e seguono le stesse convenzioni.
Ogni bounded context avrà una propria sezione dedicata nella documentazione man mano che la copertura si espande. Nel frattempo, il browser dello schema Voyager integrato è un ottimo modo per esplorare il grafo completo dei tipi.
Esplorazione dello schema
L'API di Altium 365 è auto-documentante. Sono disponibili due strumenti integrati 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/
Endpoint
Endpoint del Workspace
Per la maggior parte delle integrazioni, usa l'endpoint del Workspace. È rivolto a uno specifico Workspace ed è il punto di partenza consigliato:
|
GraphQL |
Files Service |
Workspace |
|
|
Endpoint regionali
Usa un endpoint regionale quando non hai un Workspace nell'ambito dell'operazione – 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 |
Files Service |
Europa |
|
|
US West |
|
|
US East |
|
|
Asia Pacifico |
|
|
Gov Cloud |
|
|
Autenticazione
Tutte le richieste devono includere un token di accesso valido:
Authorization: Bearer {access-token}
Vedi Uso di un token di accesso per i dettagli.
In questa sezione