Skrócony przewodnik po API Altium 365

Altium 365 API zapewnia programistyczny dostęp do danych w Twojej przestrzeni roboczej — projektów, zestawień BOM, komponentów, symboli, obudów PCB i innych zasobów. Jest to interfejs API oparty na GraphQL, co oznacza, że w jednym żą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

• Przestrzeń robocza Altium 365

• Konto administratora przestrzeni roboczej

• Konto w Altium Developer Center – portalu samoobsługowym Altium dla programistów, w którym możesz dołączać 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 przestrzeni roboczej 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ż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 tokenu 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 programistycznie 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ę.

Opis procesu wymiany znajdziesz w sekcji Korzystanie z tokenu odświeżania.

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ą swojej przestrzeni roboczej, aby uzyskać na przykład https://my-company.365.altium.com/api/graphql.

Autoryzuj żądanie

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

Authorization: Bearer {access-token}

Uruchom pierwsze zapytanie

Na początek warto użyć zapytania wyświetlającego listę projektów w Twojej przestrzeni roboczej:

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

Wklej je do IDE, kliknij Run, a w odpowiedzi powinny pojawić się projekty z Twojej przestrzeni roboczej.

Możesz również przeglądać pełny schemat API w formie graficznej pod adresem:

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

Kolejne kroki

• Przejrzyj organizację AltiumDeveloper w serwisie GitHub, aby znaleźć aplikacje demonstracyjne i przykładowe zapytania

• Zobacz sekcję Korzystanie z tokenu dostępu, aby dowiedzieć się, jak używać tokenów w kodzie i skryptach

• Zobacz sekcję Korzystanie z tokenu odświeżania dotyczącą zautomatyzowanych integracji