API Altium 365
API Altium 365 to interfejs API oparty na GraphQL, który zapewnia programowy dostęp do danych w przestrzeni roboczej Altium 365. Obsługuje operacje odczytu i zapisu w całym zakresie funkcji platformy.
Organizacja API
Struktura API jest oparta na obszarach domenowych platformy, określanych jako bounded contexts. Każdy ograniczony kontekst obejmuje konkretny obszar platformy — jego encje, operacje i reguły biznesowe. Nazwy typów i zapytań GraphQL są zgodne z konwencjami nazewnictwa odzwierciedlającymi obszar domenowy, do którego należą, co ułatwia poruszanie się po schemacie po zapoznaniu się z jego strukturą.
Główne ograniczone konteksty
Ograniczony kontekst |
Zakres |
Design |
Projekty PCB, schematy, warianty, wydania, pakiety produkcyjne |
Library |
Komponenty, symbole, footprinty, części, wnioski o części, karty katalogowe |
Procurement |
Zestawienia materiałowe, pozycje BOM, części alternatywne i zamienne |
Platform |
Użytkownicy, przestrzenie robocze, organizacje, definicje cyklu życia, nazewnictwo rewizji |
Collaboration |
Komentarze, wątki komentarzy, zadania |
Customization |
Przepływy pracy, skrypty, wykonania skryptów |
Dodatkowe ograniczone konteksty obejmują bardziej wyspecjalizowane funkcje — modelowanie urządzeń, bezprzewodowe aktualizacje oprogramowania układowego, zarządzanie wymaganiami, oprogramowanie wbudowane i projektowanie systemów. Są one dostępne za pośrednictwem tego samego API i podlegają tym samym konwencjom.
Każdy ograniczony kontekst ma własną sekcję w dokumentacji API Altium 365, zawierającą należące do niego typy, zapytania i mutacje. Aby zobaczyć powiązania między typami w różnych kontekstach, użyj przeglądarki schematu Voyager.
Punkty końcowe
Regionalne punkty końcowe
Użyj regionalnego punktu końcowego, gdy nie działasz w kontekście konkretnej przestrzeni roboczej — na przykład aby wyświetlić listę wszystkich przestrzeni roboczych, 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 |
Voyager (przeglądanie schematu) |
Europa |
|
|
https://eur.365.altium.com/api/voyager |
Zachodnie USA |
|
|
https://usw.365.altium.com/api/voyager |
Wschodnie USA |
|
|
https://use.365.altium.com/api/voyager |
Azja i Pacyfik |
|
|
https://asp.365.altium.com/api/voyager |
GovCloud |
|
|
https://use.365-gov.altium.com/api/voyager |
Punkty końcowe przestrzeni roboczej
Punkty końcowe przestrzeni roboczej to zalecany punkt wyjścia do pracy z zasobami konkretnej przestrzeni roboczej. Punkty końcowe API korzystają z tej samej domeny co przestrzeń robocza i można je wykrywać programowo — zobacz przykład Wyświetlanie listy przestrzeni roboczych.
GraphQL |
Usługa plików |
Voyager (przeglądanie schematu) |
|
|
https://{workspace-domain}/api/voyager |
Przeglądanie schematu
-
API Reference – dokumentacja API Altium 365 obejmująca cały schemat, z możliwością przeglądania i wyszukiwania oraz z przykładami
-
Nitro – przeglądarkowe środowisko IDE GraphQL do interaktywnego pisania i uruchamiania zapytań:
https://{workspace-domain}/api/graphql/ -
Voyager – wizualny graf całego schematu, pomocny w zrozumieniu relacji między typami:
https://{workspace-domain}/api/voyager/
Uwierzytelnianie
Wszystkie żądania muszą zawierać prawidłowy token dostępu:
Authorization: Bearer {access-token}
Szczegółowe informacje znajdziesz w sekcji Korzystanie z tokenu dostępu.
Powiązane zasoby
-
Dokumentacja API Altium 365 – pełna dokumentacja GraphQL.
-
Dokumentacja API Altium 365 — llms.txt – indeks dokumentacji w formacie czytelnym maszynowo, przeznaczony dla asystentów programowania opartych na AI.
-
Biblioteki uwierzytelniania Altium – biblioteki klienckie OAuth2/OIDC + PKCE do logowania użytkowników.
-
Altium Developer w serwisie GitHub – zestawy SDK, przykłady i źródła dokumentacji.
W tej sekcji