API Altium 365
API Altium 365 to interfejs API oparty na GraphQL, który zapewnia programowy dostęp do danych w Twojej przestrzeni roboczej Altium 365. Obsługuje operacje odczytu i zapisu w całym zakresie funkcjonalności platformy.
Organizacja API
Struktura API opiera się 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żą. Ułatwia to 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 zamienniki |
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 stosują te same konwencje.
W miarę rozbudowy dokumentacji każdy ograniczony kontekst otrzyma własną, dedykowaną sekcję. Do tego czasu wbudowana przeglądarka schematu Voyager pozwala wygodnie poznawać pełny graf typów.
Punkty końcowe
Regionalne punkty końcowe
Użyj regionalnego punktu końcowego, gdy operacja nie dotyczy konkretnej przestrzeni roboczej — na przykład, aby wyświetlić wszystkie przestrzenie robocze, do których użytkownik ma dostęp — lub podczas pracy 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 |
Zachód USA |
|
|
https://usw.365.altium.com/api/voyager |
Wschód 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 są zalecanym punktem wyjścia do pracy z zasobami danej przestrzeni roboczej. Punkty końcowe API korzystają z tej samej domeny przestrzeni roboczej 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 Altium 365 jest samodokumentujące. Bezpośrednio pod adresem URL Twojej przestrzeni roboczej dostępne są dwa wbudowane narzędzia:
-
Nitro – przeglądarkowe środowisko IDE GraphQL do interaktywnego tworzenia i wykonywania zapytań:
https://{workspace-domain}/api/graphql/ -
Voyager – wizualny graf pełnego 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.
W tej sekcji
Tłumaczenie SI