Guida rapida all'API di Altium 365
Altium 365 API offre accesso programmatico ai dati del tuo Workspace: progetti, distinte base, componenti, simboli, footprint e altro ancora. È un'API GraphQL, quindi puoi ottenere esattamente i dati di cui hai bisogno con un'unica richiesta.
Questa guida ti accompagna da zero alla tua prima chiamata API in pochi minuti.
Prerequisiti
-
Un Workspace Altium 365
-
Un account amministratore del Workspace
-
Un account su Altium Developer Center – il portale self-service di Altium per gli sviluppatori, dove puoi iscriverti ai programmi per accedere ad Altium 365 API, Altium Designer SDK, Embeddable Viewer e altri prodotti per sviluppatori
Passaggio 1: crea un token
Per autorizzare le richieste API, è necessario un token di accesso. I token vengono creati nel tuo Workspace in Admin → Developer.
Quando crei un token, puoi scegliere tra le due opzioni seguenti.
Opzione A: token di accesso a lunga durata
Il modo più semplice per iniziare. Ricevi un unico token di accesso con una durata configurabile (fino a 1 anno). Usalo direttamente nelle richieste API.
Ideale per: esplorazioni rapide, script e integrazioni in cui la semplicità è la priorità.
Per i dettagli, consulta Utilizzo di un token di accesso.
Opzione B: token di aggiornamento (consigliato per la produzione)
Un approccio più sicuro. Ricevi un refresh token insieme a un client ID e un client secret. Il token di aggiornamento viene scambiato programmaticamente con un token di accesso a breve durata, che viene poi utilizzato nelle richieste API. Il token di aggiornamento stesso ha una durata configurabile (fino a 1 anno).
Ideale per: integrazioni automatizzate, servizi in background e qualsiasi applicazione in esecuzione in produzione 24 ore su 24, 7 giorni su 7.
Per la procedura di scambio, consulta Utilizzo di un token di aggiornamento.
Passaggio 2: effettua la tua prima richiesta API
Il modo più rapido per esplorare Altium 365 API è utilizzare l'IDE integrato nel browser (basato su Nitro). Vai a:
https://{workspace-subdomain}.365.altium.com/api/graphql/
Sostituisci {workspace-subdomain} con il sottodominio effettivo del tuo Workspace, ottenendo ad esempio https://my-company.365.altium.com/api/graphql.
Autorizza la richiesta
Tutte le richieste API richiedono un token di accesso passato nell'intestazione HTTP Authorization con lo schema Bearer:
Authorization: Bearer {access-token}
Esegui la tua prima query
Una buona query per iniziare consiste nell'elencare i progetti del tuo Workspace:
query {
desProjects(first: 10) {
nodes {
id
name
description
}
}
}
Incollala nell'IDE, fai clic su Run e dovresti vedere i progetti del tuo Workspace nella risposta.
Ogni campo di questa query è documentato nella Guida di riferimento di Altium 365 API. Consulta desProjects per i filtri e gli argomenti di ordinamento e paginazione disponibili.
Puoi anche esplorare visivamente lo schema completo dell'API all'indirizzo:
https://{workspace-subdomain}.365.altium.com/api/voyager
Passaggi successivi
-
Consulta la Guida di riferimento di Altium 365 API: tutte le query, le mutazioni e i tipi, raggruppati per contesto delimitato
-
Consulta Utilizzo di un token di accesso per usare i token nel codice e negli script
-
Consulta Utilizzo di un token di aggiornamento per le integrazioni automatizzate
-
Clona platform-api-first-query per ottenere un'app "Hello Workspace" ed esempi di casi d'uso in diversi linguaggi
-
Stai creando un'app che consente agli utenti di accedere? Usa le librerie di autenticazione Altium.
-
- Esplora l'organizzazione AltiumDeveloper su GitHub per altri SDK e app dimostrative.