API di Altium 365

L'API di Altium 365 è un'API GraphQL che fornisce accesso programmatico ai dati del tuo Workspace Altium 365. Supporta operazioni sia di lettura sia di scrittura su tutta la piattaforma.

New to Altium 365 API? Inizia dalla guida rapida per creare il tuo primo token ed effettuare la tua prima chiamata API in pochi minuti.

Looking for the API reference? Ogni query, mutazione e tipo è documentato nella Guida di riferimento dell'API di Altium 365.

Organizzazione dell'API

L'API è strutturata in base alle aree di dominio della piattaforma, note come bounded contexts. Ogni contesto delimitato copre un'area specifica della piattaforma: 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, semplificando la navigazione nello schema una volta acquisita familiarità con la struttura.

Principali contesti delimitati

Contesto delimitato

Ambito

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, discussioni, attività

Customization

Flussi di lavoro, script, esecuzioni di script

Ulteriori contesti delimitati coprono funzionalità più specializzate:  modellazione dei dispositivi, aggiornamenti firmware over-the-air, gestione dei requisiti, software embedded e progettazione di sistemi. Queste funzionalità sono accessibili tramite la stessa API e seguono le stesse convenzioni.

Ogni contesto delimitato ha una propria sezione nella Guida di riferimento dell'API di Altium 365, con i tipi, le query e le mutazioni che gli appartengono. Per vedere le relazioni tra i tipi nei diversi contesti, usa il browser dello schema Voyager.

Endpoint

Endpoint regionali

Usa un endpoint regionale quando non operi nell'ambito di un Workspace, 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/graphql

https://eur.365.altium.com/api/files

https://eur.365.altium.com/api/voyager

Stati Uniti occidentali

https://usw.365.altium.com/api/graphql

https://usw.365.altium.com/api/files

https://usw.365.altium.com/api/voyager

Stati Uniti orientali

https://use.365.altium.com/api/graphql

https://use.365.altium.com/api/files

https://use.365.altium.com/api/voyager

Asia-Pacifico

https://asp.365.altium.com/api/graphql

https://asp.365.altium.com/api/files

https://asp.365.altium.com/api/voyager

GovCloud

https://use.365-gov.altium.com/api/graphql

https://use.365-gov.altium.com/api/files

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 usano lo stesso dominio del Workspace e possono essere individuati a livello di codice: vedi l'esempio Elencare i Workspace.

GraphQL

Servizio file

Voyager (esplorazione dello schema)

https://{workspace-domain}/api/graphql

https://{workspace-domain}/api/files

https://{workspace-domain}/api/voyager

Esplorazione dello schema

  • API Reference – Guida di riferimento dell'API di Altium 365 navigabile e consultabile tramite ricerca, che copre l'intero schema e include esempi

  • 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}

Per i dettagli, consulta Utilizzo di un token di accesso.

Risorse correlate

In questa sezione

 

AI-LocalizedLocalizzato tramite A
Se trovi un problema, seleziona il testo/l’immagine e premi Ctrl + Enter per inviarci il tuo feedback.
Contents
Contents