Altium 365 API

Updated: Sierpień 26, 2026

API Altium 365 to interfejs GraphQL, który zapewnia programistyczny dostęp do danych w Twoim Workspace Altium 365. Obsługuje zarówno operacje odczytu, jak i zapisu w pełnym zakresie funkcji platformy.

New to Altium 365 API? Zacznij od przewodnika szybkiego startu, aby w kilka minut utworzyć swój pierwszy token i wykonać pierwsze wywołanie API.

Jak zorganizowane jest API

API jest zorganizowane wokół obszarów domenowych platformy, nazywanych bounded contexts. Każdy bounded context obejmuje określony obszar platformy – jego encje, operacje i reguły biznesowe. Nazwy typów i zapytań GraphQL są zgodne z konwencjami nazewniczymi odzwierciedlającymi obszar domenowy, do którego należą, co ułatwia poruszanie się po schemacie po zapoznaniu się z jego strukturą.

Główne bounded contexts

Bounded context	Co obejmuje
Design	Projekty PCB, schematy, warianty, wydania, pakiety produkcyjne
Library	Komponenty, symbole, footprinty, części, zgłoszenia części, arkusze danych
Procurement	Zestawienia materiałowe, pozycje BOM, części alternatywne i zamienne
Platform	Użytkownicy, Workspaces, organizacje, definicje cyklu życia, nazewnictwo rewizji
Collaboration	Komentarze, wątki komentarzy, zadania
Customization	Workflow, skrypty, wykonania skryptów

Dodatkowe bounded contexts obejmują bardziej wyspecjalizowane funkcje – modelowanie urządzeń, aktualizacje firmware over-the-air, zarządzanie wymaganiami, oprogramowanie wbudowane oraz projektowanie systemów. Są one dostępne przez to samo API i stosują te same konwencje.

Każdy bounded context będzie miał własną dedykowaną sekcję dokumentacji w miarę rozszerzania zakresu. Wbudowana przeglądarka schematu Voyager to tymczasem dobry sposób na poznanie pełnego grafu typów.

Poznawanie schematu

API Altium 365 jest samodokumentujące się. Dwa wbudowane narzędzia są dostępne bezpośrednio pod adresem URL Twojego Workspace:

Nitro – przeglądarkowe środowisko GraphQL IDE do interaktywnego pisania i uruchamiania zapytań:
```
https://{workspace-domain}/api/graphql/
```
Voyager – wizualny graf kompletnego schematu, przydatny do zrozumienia relacji między typami:
```
https://{workspace-domain}/api/voyager/
```

Punkty końcowe

Punkt końcowy Workspace

W przypadku większości integracji użyj punktu końcowego Workspace. Jest on skierowany do konkretnego Workspace i stanowi zalecany punkt wyjścia:

	GraphQL	Usługa plików
Workspace	`https://{workspace-domain}/api/graphql`	`https://{workspace-domain}/api/files`

Regionalne punkty końcowe

Użyj regionalnego punktu końcowego, gdy nie pracujesz w kontekście konkretnego Workspace – na przykład aby wyświetlić wszystkie Workspaces, do których użytkownik ma dostęp – lub gdy pracujesz z danymi globalnymi, takimi jak użytkownicy i organizacje.

Region	GraphQL	Usługa plików
Europa	`https://eur.365.altium.com/api/graphql`	`https://eur.365.altium.com/api/files`
Zachodnie USA	`https://usw.365.altium.com/api/graphql`	`https://usw.365.altium.com/api/files`
Wschodnie USA	`https://use.365.altium.com/api/graphql`	`https://use.365.altium.com/api/files`
Azja i Pacyfik	`https://asp.365.altium.com/api/graphql`	`https://asp.365.altium.com/api/files`
GovCloud	`https://use.365-gov.altium.com/api/graphql`	`https://use.365-gov.altium.com/api/files`

Uwierzytelnianie

Wszystkie żądania muszą zawierać prawidłowy token dostępu:

Authorization: Bearer {access-token}

Szczegóły znajdziesz w sekcji Using an Access Token .

W tej sekcji

Wersja do wydruku

Tłumaczenie SI

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