Altium 365 API

Updated: May 21, 2026

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.

New to Altium 365 API? Beginnen Sie mit der Schnellstartanleitung, um in wenigen Minuten Ihr erstes Token zu erstellen und Ihren ersten API-Aufruf auszuführen.

Wie die API organisiert ist

Die API ist nach den Domänenbereichen der Plattform strukturiert, die als bounded contexts bezeichnet werden. Jeder begrenzte Kontext deckt einen bestimmten Bereich der Plattform ab – seine Entitäten, Operationen und Geschäftsregeln. Namen von GraphQL-Typen und -Abfragen folgen Namenskonventionen, die den jeweiligen Domänenbereich widerspiegeln, zu dem sie gehören. Dadurch lässt sich das Schema leichter navigieren, sobald Sie mit der Struktur vertraut sind.

Wichtige begrenzte Kontexte

Begrenzter Kontext	Was er abdeckt
Design	PCB-Projekte, Schaltpläne, Varianten, Releases, Fertigungspakete
Library	Komponenten, Symbole, Footprints, Teile, Teileanfragen, Datenblätter
Procurement	Stücklisten, BOM-Positionen, alternative und Ersatzteile
Platform	Benutzer, Workspaces, Organisationen, Lifecycle-Definitionen, Revisionsbenennung
Collaboration	Kommentare, Kommentar-Threads, Aufgaben
Customization	Workflows, Skripte, Skriptausführungen

Zusätzliche begrenzte Kontexte decken weitere spezialisierte Funktionen ab – Gerätemodellierung, Over-the-Air-Firmware-Updates, Anforderungsmanagement, Embedded-Software und Systemdesign. Diese sind über dieselbe API zugänglich und folgen denselben Konventionen.

Jeder begrenzte Kontext erhält einen eigenen Dokumentationsabschnitt, sobald der Funktionsumfang erweitert wird. Der integrierte Voyager-Schema-Browser ist in der Zwischenzeit eine gute Möglichkeit, den vollständigen Typgraphen zu erkunden.

Das Schema erkunden

Die Altium 365 API ist selbstdokumentierend. Zwei integrierte Werkzeuge sind direkt über die URL Ihres Workspace verfügbar:

Nitro – eine browserbasierte GraphQL-IDE zum interaktiven Schreiben und Ausführen von Abfragen:
```
https://{workspace-domain}/api/graphql/
```
Voyager – ein visuelles Diagramm des vollständigen Schemas, nützlich zum Verständnis der Beziehungen zwischen Typen:
```
https://{workspace-domain}/api/voyager/
```

Endpunkte

Workspace-Endpunkt

Verwenden Sie für die meisten Integrationen den Workspace-Endpunkt. Er ist auf einen bestimmten Workspace ausgerichtet und der empfohlene Einstiegspunkt:

	GraphQL	Dateidienst
Workspace	`https://{workspace-domain}/api/graphql`	`https://{workspace-domain}/api/files`

Regionale Endpunkte

Verwenden Sie einen regionalen Endpunkt, wenn kein Workspace im Geltungsbereich ist – zum Beispiel, um alle Workspaces aufzulisten, auf die ein Benutzer Zugriff hat – oder wenn Sie mit globalen Daten wie Benutzern und Organisationen arbeiten.

Region	GraphQL	Dateidienst
Europa	`https://eur.365.altium.com/api/graphql`	`https://eur.365.altium.com/api/files`
US West	`https://usw.365.altium.com/api/graphql`	`https://usw.365.altium.com/api/files`
US East	`https://use.365.altium.com/api/graphql`	`https://use.365.altium.com/api/files`
Asien-Pazifik	`https://asp.365.altium.com/api/graphql`	`https://asp.365.altium.com/api/files`
Gov Cloud	`https://use.365-gov.altium.com/api/graphql`	`https://use.365-gov.altium.com/api/files`

Authentifizierung

Alle Anfragen müssen ein gültiges Zugriffstoken enthalten:

Authorization: Bearer {access-token}

Siehe Verwendung eines Zugriffstokens für Details.

In diesem Abschnitt

Druckerfreundliche Version

AI-localized

Wenn Sie ein Problem feststellen, wählen Sie den Text/das Bild aus und drücken SieStrg + Eingabe, um uns Ihr Feedback zu senden.