Przewodnik szybkiego startu po API Altium 365

API Altium 365 zapewnia programowy dostęp do danych w Twoim Workspace — projektów, BOM-ów, komponentów, symboli, footprintów i nie tylko. Jest to API GraphQL, co oznacza, że w pojedynczym żądaniu możesz pobrać dokładnie te dane, których potrzebujesz.

Ten przewodnik pozwoli Ci przejść od zera do pierwszego wywołania API w kilka minut.

Wymagania wstępne

• Workspace Altium 365

• Konto administratora Workspace

• Konto w Altium Developer Center — samoobsługowym portalu Altium dla deweloperów, gdzie możesz dołączyć do programów zapewniających dostęp do API Altium 365, Altium Designer SDK, Embeddable Viewer oraz innych produktów deweloperskich

Krok 1: Utwórz token

Aby autoryzować żądania API, potrzebujesz tokenu dostępu. Tokeny są tworzone w Twoim Workspace w sekcji Admin → Developer.

Podczas tworzenia tokenu możesz wybrać jedną z dwóch poniższych opcji.

Opcja A: Długoterminowy token dostępu

Najprostszy sposób na rozpoczęcie pracy. Otrzymujesz pojedynczy token dostępu z konfigurowalnym okresem ważności (do 1 roku). Używasz go bezpośrednio w żądaniach API.

Dobre rozwiązanie dla: szybkiego poznawania API, skryptów i integracji, w których priorytetem jest prostota.

Zobacz Using an Access token, aby poznać szczegóły.

Opcja B: Refresh Token (zalecane w środowisku produkcyjnym)

Bardziej bezpieczne podejście. Otrzymujesz refresh token wraz z client ID i client secret. Refresh token jest programowo wymieniany na krótkoterminowy token dostępu, który następnie jest używany w żądaniach API. Sam refresh token również ma konfigurowalny okres ważności (do 1 roku).

Dobre rozwiązanie dla: zautomatyzowanych integracji, usług działających w tle oraz wszystkiego, co działa produkcyjnie 24/7.

Zobacz Using a Refresh Token, aby poznać proces wymiany.

Krok 2: Wykonaj swoje pierwsze żądanie API

Najszybszym sposobem na poznanie API Altium 365 jest użycie wbudowanego przeglądarkowego IDE (opartego na Nitro). Przejdź do:

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

Zastąp {workspace-domain} rzeczywistą domeną swojego Workspace (na przykład mycompany.altium.com).

Autoryzuj swoje żądanie

Wszystkie żądania API wymagają tokenu dostępu przekazywanego w nagłówku HTTP Authorization ze schematem Bearer:

Authorization: Bearer {access-token}

Uruchom swoje pierwsze zapytanie

Dobrym zapytaniem na początek jest wyświetlenie listy projektów w Twoim Workspace:

query {
  desProjects(first: 10) {
    nodes {
      id
      name
      description
    }
  }
}

Wklej je do IDE, kliknij Run, a w odpowiedzi powinny pojawić się projekty z Twojego Workspace.

Możesz także wizualnie przeglądać pełny schemat API pod adresem:

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

Kolejne kroki

• Przeglądaj organizację GitHub AltiumDeveloper, aby znaleźć aplikacje demonstracyjne i przykładowe zapytania

• Zobacz Using an Access Token, aby dowiedzieć się, jak używać tokenów w kodzie i skryptach

• Zobacz Using a Refresh Token w przypadku zautomatyzowanych integracji