Przewodnik szybkiego startu API Altium 365

Altium 365 API 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 możesz pobrać dokładnie te dane, których potrzebujesz, w ramach jednego żądania.

Ten przewodnik pozwoli Ci przejść od zera do wykonania 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 Altium 365 API, Altium Designer SDK, Embeddable Viewer i innych produktów dla deweloperów

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 do: 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 do środowisk produkcyjnych)

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 do: zautomatyzowanych integracji, usług działających w tle i wszystkiego, co działa produkcyjnie 24/7.

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

Krok 2: Wykonaj swoje pierwsze żądanie API

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

https://{workspace-domain}.altium.com/svc/napi/gateway/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 z użyciem schematu 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 powinieneś zobaczyć projekty ze swojego Workspace.

Pełny schemat API możesz również przeglądać wizualnie tutaj:

https://{workspace-domain}.altium.com/svc/napi/gateway/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