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 Schreibvorgänge über den gesamten Funktionsumfang der Plattform hinweg.

New to Altium 365 API? Beginnen Sie mit dem Schnellstart-Leitfaden, 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 abgegrenzte Kontext deckt einen bestimmten Bereich der Plattform ab – seine Entitäten, Operationen und Geschäftsregeln. Die Namen von GraphQL-Typen und -Abfragen folgen Benennungskonventionen, die den jeweiligen Domänenbereich widerspiegeln, zu dem sie gehören. Dadurch wird die Navigation im Schema einfacher, sobald Sie mit der Struktur vertraut sind.

Wichtigste abgegrenzte Kontexte

Abgegrenzter Kontext

Was er abdeckt

Design

PCB-Projekte, Schaltpläne, Varianten, Releases, Fertigungspakete

Library

Komponenten, Symbole, Footprints, Teile, Teileanfragen, Datenblätter

Procurement

Stücklisten, BOM-Elemente, alternative und Ersatzteile

Platform

Benutzer, Workspaces, Organisationen, Lifecycle-Definitionen, Revisionsbenennung

Collaboration

Kommentare, Kommentar-Threads, Aufgaben

Customization

Workflows, Skripte, Skriptausführungen

Zusätzliche abgegrenzte Kontexte 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 abgegrenzte Kontext erhält im Zuge der Erweiterung der Abdeckung einen eigenen Dokumentationsabschnitt. 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 zielt auf einen bestimmten Workspace ab und ist der empfohlene Ausgangspunkt:

 

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

GovCloud

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

 

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.
Inhalt