Kurzanleitung zur Altium 365 API

Die Altium 365 API ermöglicht Ihnen den programmatischen Zugriff auf Ihre Workspace-Daten – Projekte, Stücklisten, Bauteile, Symbole, Footprints und mehr. Es handelt sich um eine GraphQL-API. Das bedeutet, dass Sie mit einer einzigen Anfrage genau die Daten abfragen können, die Sie benötigen.

Mit dieser Anleitung gelangen Sie in wenigen Minuten von null zu Ihrem ersten API-Aufruf.

Voraussetzungen

• Ein Altium 365 Workspace

• Ein Workspace-Administratorkonto

• Ein Konto im Altium Developer Center – dem Self-Service-Portal von Altium für Entwickler, in dem Sie sich für Programme anmelden können, um Zugriff auf die Altium 365 API, das Altium Designer SDK, den Embeddable Viewer und weitere Entwicklerprodukte zu erhalten

Schritt 1: Ein Token erstellen

Um API-Anfragen zu autorisieren, benötigen Sie ein Zugriffstoken. Tokens werden in Ihrem Workspace unter Admin → Developer erstellt.

Beim Erstellen eines Tokens können Sie zwischen den folgenden beiden Optionen wählen.

Option A: Langlebiges Zugriffstoken

Der einfachste Einstieg. Sie erhalten ein einzelnes Zugriffstoken mit einer konfigurierbaren Gültigkeitsdauer (bis zu 1 Jahr). Verwenden Sie es direkt in API-Anfragen.

Geeignet für: erste Erkundungen, Skripte und Integrationen, bei denen Einfachheit im Vordergrund steht.

Weitere Informationen finden Sie unter Verwendung eines Zugriffstokens.

Option B: Aktualisierungstoken (für den Produktivbetrieb empfohlen)

Ein sichererer Ansatz. Sie erhalten ein refresh token zusammen mit einem client ID und einem client secret. Das Aktualisierungstoken wird programmatisch gegen ein kurzlebiges Zugriffstoken ausgetauscht, das anschließend für API-Anfragen verwendet wird. Das Aktualisierungstoken selbst hat eine konfigurierbare Gültigkeitsdauer (bis zu 1 Jahr).

Geeignet für: automatisierte Integrationen, Hintergrunddienste und alle Anwendungen, die rund um die Uhr im Produktivbetrieb laufen.

Den Ablauf des Austauschs finden Sie unter Verwendung eines Aktualisierungstokens.

Schritt 2: Ihre erste API-Anfrage stellen

Am schnellsten erkunden Sie die Altium 365 API über die integrierte Browser-IDE (basierend auf Nitro). Navigieren Sie zu:

https://{workspace-subdomain}.365.altium.com/api/graphql/

Ersetzen Sie {workspace-subdomain} durch die tatsächliche Subdomain Ihres Workspace, sodass sich beispielsweise https://my-company.365.altium.com/api/graphql ergibt.

Ihre Anfrage autorisieren

Für alle API-Anfragen ist ein Zugriffstoken erforderlich, das im HTTP-Header Authorization mit dem Schema Bearer übergeben wird:

Authorization: Bearer {access-token}

Ihre erste Abfrage ausführen

Ein guter Einstieg ist eine Abfrage, die Ihre Workspace-Projekte auflistet:

query {
  desProjects(first: 10) {
    nodes {
      id
      name
      description
    }
  }
}

Fügen Sie diese in die IDE ein und klicken Sie auf Run. Daraufhin sollten Ihre Workspace-Projekte in der Antwort angezeigt werden.

Sie können das vollständige API-Schema auch visuell erkunden unter:

https://{workspace-subdomain}.365.altium.com/api/voyager

Nächste Schritte

• Durchsuchen Sie die GitHub-Organisation AltiumDeveloper nach Demo-Anwendungen und Beispielabfragen

• Informationen zur Verwendung von Tokens in Code und Skripten finden Sie unter Verwendung eines Zugriffstokens

• Informationen zu automatisierten Integrationen finden Sie unter Verwendung eines Aktualisierungstokens