Skrócona instrukcja obsługi API Altium 365

Altium 365 API jest obecnie w fazie zamkniętych testów beta i jest dostępne tylko dla kilku wybranych klientów korzystających z wczesnego dostępu.

Altium 365 API zapewnia programowy dostęp do danych w Twoim obszarze roboczym — projektów, zestawień materiałowych (BOM), komponentów, symboli, footprintów i nie tylko. Jest to API oparte na GraphQL, co oznacza, że w jednym żądaniu możesz pobrać dokładnie te dane, których potrzebujesz.

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

Wymagania wstępne

  • Obszar roboczy Altium 365

  • Konto administratora obszaru roboczego

  • Konto w Altium Developer Center – samoobsługowym portalu Altium dla programistów, w którym 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 programistów

Krok 1: Utwórz token

Do autoryzacji żądań API potrzebny jest token dostępu. Tokeny tworzy się w obszarze roboczym w sekcji Admin → Developer.

Podczas tworzenia tokena 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 jeden token dostępu z konfigurowalnym okresem ważności (do 1 roku). Używaj go bezpośrednio w żądaniach API.

Sprawdza się w przypadku: szybkiego poznawania API, skryptów i integracji, w których priorytetem jest prostota.

Szczegółowe informacje znajdziesz w sekcji Korzystanie z tokena dostępu.

Opcja B: Token odświeżania (zalecany w środowisku produkcyjnym)

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

Sprawdza się w przypadku: zautomatyzowanych integracji, usług działających w tle i wszelkich rozwiązań działających w środowisku produkcyjnym przez całą dobę.

Przebieg wymiany opisano w sekcji Korzystanie z tokena odświeżania.

Your tokens are shown once. W momencie utworzenia wszystkie tokeny i dane uwierzytelniające są wyświetlane na ekranie. Skopiuj je i zapisz w bezpiecznym miejscu — Altium nie przechowuje tokenów i nie może ich ponownie wyświetlić po opuszczeniu strony.

Krok 2: Wyślij pierwsze żądanie API

Najszybszym sposobem na poznanie Altium 365 API jest skorzystanie z wbudowanego środowiska IDE w przeglądarce (opartego na Nitro). Przejdź do:

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

Zastąp {workspace-subdomain} rzeczywistą subdomeną swojego obszaru roboczego, aby uzyskać na przykład https://my-company.365.altium.com/api/graphql.

Autoryzuj żądanie

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

Authorization: Bearer {access-token}

Uruchom pierwsze zapytanie

Dobrym punktem wyjścia jest zapytanie wyświetlające listę projektów w obszarze roboczym:

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

Wklej je do IDE, kliknij Run, a w odpowiedzi powinna pojawić się lista projektów z Twojego obszaru roboczego.

Każde pole w tym zapytaniu opisano w dokumentacji referencyjnej Altium 365 API. Zobacz desProjects, aby poznać dostępne filtry oraz argumenty sortowania i stronicowania.

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

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

Kolejne kroki

 

AI-LocalizedTłumaczenie SI
Jeśli znajdziesz błąd, zaznacz tekst/obraz i naciśnij Ctrl + Enter aby wysłać nam wiadomość.
Contents
Contents