Guida rapida introduttiva all'API di Altium 365

Altium 365 API ti offre un accesso programmatico ai dati del tuo Workspace: progetti, BOM, componenti, simboli, footprint e altro ancora. Si tratta di un'API GraphQL, il che significa che puoi interrogare esattamente i dati di cui hai bisogno con una singola richiesta.

Questa guida ti porta 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: creare un token

Per autorizzare le richieste API, ti serve un token di accesso. I token vengono creati nel tuo Workspace in Admin → Developer.

Durante la creazione di 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 singolo token di accesso con una durata configurabile (fino a 1 anno). Usalo direttamente nelle richieste API.

Ideale per: esplorazione rapida, script e integrazioni in cui la semplicità è la priorità.

Vedi Using an Access token per i dettagli.

Opzione B: refresh token (consigliato per la produzione)

Un approccio più sicuro. Ricevi un refresh token insieme a un client ID e a un client secret. Il refresh token viene scambiato programmaticamente con un token di accesso a breve durata, che viene poi utilizzato nelle richieste API. Il refresh token stesso ha una durata configurabile (fino a 1 anno).

Ideale per: integrazioni automatizzate, servizi in background e qualsiasi soluzione in esecuzione in produzione 24/7.

Vedi Using a Refresh Token per il flusso di scambio.

Passaggio 2: esegui la tua prima richiesta API

Il modo più rapido per esplorare Altium 365 API è tramite l'IDE browser integrato (basato su Nitro). Vai a:

https://{workspace-domain}.altium.com/api/graphql/

Sostituisci {workspace-domain} con il dominio effettivo del tuo Workspace (ad esempio, mycompany.altium.com).

Autorizza la tua richiesta

Tutte le richieste API richiedono un token di accesso passato nell'header HTTP Authorization con schema Bearer:

Authorization: Bearer {access-token}

Esegui la tua prima query

Una buona query iniziale 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.

Puoi anche esplorare visivamente lo schema API completo qui:

https://{workspace-domain}.altium.com/api/voyager

Passaggi successivi

• Sfoglia l'organizzazione GitHub AltiumDeveloper per app dimostrative ed esempi di query

• Vedi Using an Access Token per utilizzare i token in codice e script

• Vedi Using a Refresh Token per integrazioni automatizzate