Altium 365 API

Die Altium 365 API ist eine GraphQL-API, die programmatischen Zugriff auf Ihre Altium 365 Workspace-Daten 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 durchzuführen.

Looking for the API reference? Jede Abfrage, jede Mutation und jeder Typ ist in der Altium 365 API-Referenz dokumentiert.

Aufbau der API

Die API ist nach den Domänenbereichen der Plattform strukturiert, den sogenannten bounded contexts. Jeder Bounded Context deckt einen bestimmten Bereich der Plattform ab – dessen Entitäten, Operationen und Geschäftsregeln. Die Namen von GraphQL-Typen und -Abfragen folgen Namenskonventionen, die den jeweiligen Domänenbereich widerspiegeln. Sobald Sie mit der Struktur vertraut sind, erleichtert dies die Navigation im Schema.

Wichtigste Bounded Contexts

Bounded Context

Abgedeckte Bereiche

Design

Leiterplattenprojekte, Schaltpläne, Varianten, Freigaben, Fertigungspakete

Library

Bauelemente, 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 speziellere 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 Bounded Context hat in der Altium 365 API-Referenz einen eigenen Abschnitt mit den zugehörigen Typen, Abfragen und Mutationen. Um die Beziehungen zwischen Typen über Kontextgrenzen hinweg zu erkunden, verwenden Sie den Voyager-Schemabrowser.

Endpunkte

Regionale Endpunkte

Verwenden Sie einen regionalen Endpunkt, wenn kein bestimmter Workspace im Kontext steht – 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/graphql

https://eur.365.altium.com/api/files

https://eur.365.altium.com/api/voyager

USA West

https://usw.365.altium.com/api/graphql

https://usw.365.altium.com/api/files

https://usw.365.altium.com/api/voyager

USA Ost

https://use.365.altium.com/api/graphql

https://use.365.altium.com/api/files

https://use.365.altium.com/api/voyager

Asien-Pazifik

https://asp.365.altium.com/api/graphql

https://asp.365.altium.com/api/files

https://asp.365.altium.com/api/voyager

GovCloud

https://use.365-gov.altium.com/api/graphql

https://use.365-gov.altium.com/api/files

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-Domain und lassen sich programmatisch ermitteln – siehe das Beispiel Workspaces auflisten.

GraphQL

Dateidienst

Voyager (Schemaerkundung)

https://{workspace-domain}/api/graphql

https://{workspace-domain}/api/files

https://{workspace-domain}/api/voyager

Das Schema erkunden

  • API Reference – durchsuchbare Altium 365 API-Referenz für das gesamte Schema, mit Beispielen

  • Nitro – eine browserbasierte GraphQL-IDE zum interaktiven Schreiben und Ausführen von Abfragen:

    https://{workspace-domain}/api/graphql/
  • Voyager – eine grafische Darstellung des vollständigen Schemas, die 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.

Weiterführende Ressourcen

In diesem Abschnitt

 

AI-LocalizedKI-lokalisiert
Wenn Sie ein Problem feststellen, wählen Sie den Text/das Bild aus und drücken SieCtrl + Enter, um uns Ihr Feedback zu senden.
Contents
Contents