Altium 365 API

Updated: Maj 21, 2026

Altium 365 API to interfejs GraphQL, który zapewnia programowy dostęp do danych w Twoim Workspace Altium 365. Obsługuje zarówno operacje odczytu, jak i zapisu w pełnym zakresie 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 uporządkowane według obszarów domenowych platformy, określanych jako bounded contexts. Każdy bounded context obejmuje konkretny 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, żądania części, karty katalogowe
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	Workflowy, 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 korzystają z tych samych konwencji.

W miarę rozszerzania zakresu każdy bounded context będzie mieć własną dedykowaną sekcję dokumentacji. Wbudowana przeglądarka schematu Voyager jest tymczasem dobrym sposobem na eksplorację pełnego grafu typów.

Eksploracja schematu

Altium 365 API 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 tworzenia 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żywaj punktu końcowego Workspace. Jest on kierowany 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 masz określonego Workspace w kontekście – na przykład aby wyświetlić listę wszystkich 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 Korzystanie z tokenu dostępu .

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ść.