Altium 365 API
Die Altium 365 API ist eine GraphQL-API, die programmatischen Zugriff auf die Daten Ihres Altium 365 Workspace bietet. Sie unterstützt sowohl Lese- als auch Schreiboperationen über die gesamte Plattform hinweg.
Organisation der API
Die API ist nach den Domänenbereichen der Plattform strukturiert, die als bounded contexts bezeichnet werden. Jeder Bounded Context deckt einen bestimmten Bereich der Plattform ab – seine Entitäten, Operationen und Geschäftsregeln. Die Namen von GraphQL-Typen und -Abfragen folgen Namenskonventionen, die den jeweiligen Domänenbereich widerspiegeln. Dadurch lässt sich das Schema leichter navigieren, sobald Sie mit der Struktur vertraut sind.
Wichtigste Bounded Contexts
Bounded Context |
Abgedeckte Bereiche |
Design |
Leiterplattenprojekte, Schaltpläne, Varianten, Freigaben, Fertigungspakete |
Library |
Komponenten, Symbole, Footprints, Bauteile, Bauteilanfragen, Datenblätter |
Procurement |
Stücklisten, Stücklistenpositionen, Alternativ- und Ersatzbauteile |
Platform |
Benutzer, Workspaces, Organisationen, Lebenszyklusdefinitionen, Revisionsbenennung |
Collaboration |
Kommentare, Kommentarverläufe, Aufgaben |
Customization |
Workflows, Skripte, Skriptausführungen |
Weitere Bounded Contexts decken spezialisiertere Funktionen ab – Gerätemodellierung, drahtlose Firmware-Updates, Anforderungsmanagement, eingebettete Software und Systemdesign. Diese sind über dieselbe API zugänglich und folgen denselben Konventionen.
Mit dem Ausbau der Dokumentation erhält jeder Bounded Context einen eigenen Abschnitt. Bis dahin bietet der integrierte Schemabrowser Voyager eine gute Möglichkeit, den vollständigen Typengraphen zu erkunden.
Endpunkte
Regionale Endpunkte
Verwenden Sie einen regionalen Endpunkt, wenn Sie nicht im Kontext eines Workspace arbeiten – beispielsweise, um alle Workspaces aufzulisten, auf die ein Benutzer Zugriff hat – oder wenn Sie mit globalen Daten wie Benutzern und Organisationen arbeiten.
Region |
GraphQL |
Dateidienst |
Voyager (Schemaerkundung) |
Europa |
|
|
https://eur.365.altium.com/api/voyager |
USA West |
|
|
https://usw.365.altium.com/api/voyager |
USA Ost |
|
|
https://use.365.altium.com/api/voyager |
Asien-Pazifik |
|
|
https://asp.365.altium.com/api/voyager |
GovCloud |
|
|
https://use.365-gov.altium.com/api/voyager |
Workspace-Endpunkte
Workspace-Endpunkte sind der empfohlene Ausgangspunkt für die Interaktion mit Workspace-spezifischen Ressourcen. API-Endpunkte verwenden dieselbe Workspace-Domäne und lassen sich programmatisch ermitteln – siehe das Beispiel Workspaces auflisten.
GraphQL |
Dateidienst |
Voyager (Schemaerkundung) |
|
|
https://{workspace-domain}/api/voyager |
Das Schema erkunden
Die Altium 365 API ist selbstdokumentierend. Zwei integrierte Tools sind direkt über Ihre Workspace-URL verfügbar:
-
Nitro – eine browserbasierte GraphQL-IDE zum interaktiven Schreiben und Ausführen von Abfragen:
https://{workspace-domain}/api/graphql/ -
Voyager – eine visuelle Darstellung des vollständigen Schemas, die dabei hilft, Beziehungen zwischen Typen zu verstehen:
https://{workspace-domain}/api/voyager/
Authentifizierung
Alle Anfragen müssen ein gültiges Zugriffstoken enthalten:
Authorization: Bearer {access-token}
Weitere Informationen finden Sie unter Verwendung eines Zugriffstokens.
In diesem Abschnitt
KI-lokalisiert