Altium 365 API-Schnellstartanleitung

Die Altium 365 API gibt Ihnen programmgesteuerten Zugriff auf die Daten Ihres Workspace – Projekte, BOMs, Komponenten, Symbole, Footprints und mehr. Es handelt sich um eine GraphQL-API, das heißt, Sie können genau die Daten, die Sie benötigen, mit einer einzigen Anfrage abfragen.

Dieser Leitfaden bringt Sie in wenigen Minuten von null bis zu Ihrem ersten API-Aufruf.

Voraussetzungen

• Ein Altium 365 Workspace

• Ein Workspace-Administratorkonto

• Ein Konto im Altium Developer Center – Altiums Self-Service-Portal für Entwickler, in dem Sie sich für Programme registrieren können, um Zugriff auf die Altium 365 API, Altium Designer SDK, Embeddable Viewer und andere 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 zwei Optionen wählen.

Option A: Zugriffstoken mit langer Laufzeit

Der einfachste Weg für den 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: schnelles Erkunden, Skripte und Integrationen, bei denen Einfachheit Priorität hat.

Siehe Using an Access Token für Details.

Option B: Refresh Token (für den Produktiveinsatz empfohlen)

Ein sichererer Ansatz. Sie erhalten ein refresh token zusammen mit einem client ID und client secret. Das Refresh Token wird programmgesteuert gegen ein kurzlebiges Zugriffstoken ausgetauscht, das dann in API-Anfragen verwendet wird. Das Refresh Token selbst hat eine konfigurierbare Gültigkeitsdauer (bis zu 1 Jahr).

Geeignet für: automatisierte Integrationen, Hintergrunddienste und alles, was in der Produktion rund um die Uhr läuft.

Siehe Using a Refresh Token für den Austauschablauf.

Schritt 2: Ihre erste API-Anfrage ausführen

Der schnellste Weg, die Altium 365 API zu erkunden, ist die integrierte Browser-IDE (bereitgestellt von Nitro). Navigieren Sie zu:

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

Ersetzen Sie {workspace-domain} durch Ihre tatsächliche Workspace-Domain (zum Beispiel mycompany.altium.com).

Ihre Anfrage autorisieren

Alle API-Anfragen erfordern ein Zugriffstoken, das im HTTP-Header Authorization mit dem Schema Bearer übergeben wird:

Authorization: Bearer {access-token}

Führen Sie Ihre erste Abfrage aus

Eine gute erste Abfrage ist das Auflisten Ihrer Workspace-Projekte:

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

Fügen Sie sie in die IDE ein, klicken Sie auf Run, und Sie sollten Ihre Workspace-Projekte in der Antwort sehen.

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

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

Nächste Schritte

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

• Siehe Using an Access Token für die Verwendung von Tokens in Code und Skripten

• Siehe Using a Refresh Token für automatisierte Integrationen