Guida rapida all'API di Altium 365

Altium 365 API ti consente di accedere in modo programmatico ai dati del tuo Workspace: progetti, BOM, componenti, simboli, footprint e altro ancora. È un'API GraphQL, quindi puoi interrogare 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 singolo 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à.

Consulta Utilizzo di un token di accesso per i dettagli.

Opzione B: token di aggiornamento (consigliato per gli ambienti di produzione)

Un approccio più sicuro. Ricevi un refresh token insieme a un client ID e un client secret. Il token di aggiornamento viene scambiato in modo programmatico 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.

Consulta Utilizzo di un token di aggiornamento per la procedura di scambio.

Passaggio 2: invia 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 tua 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 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 completo dell'API all'indirizzo:

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

Passaggi successivi

• Esplora l'organizzazione GitHub AltiumDeveloper per trovare app dimostrative e query di esempio

• Consulta Utilizzo di un token di accesso per utilizzare i token nel codice e negli script

• Consulta Utilizzo di un token di aggiornamento per le integrazioni automatizzate