Altium 365 API-Schnellstartanleitung

Die Altium 365 API ermöglicht Ihnen programmgesteuerten Zugriff auf Ihre Workspace-Daten – Projekte, BOMs, Komponenten, Symbole, Footprints und mehr. Es handelt sich um eine GraphQL-API, d. h., Sie können genau die Daten abfragen, die Sie benötigen, und zwar in einer einzigen Anfrage.

Mit diesem Leitfaden kommen Sie in wenigen Minuten von null zu Ihrem ersten API-Aufruf.

Voraussetzungen

• Ein Altium 365 Workspace

• Ein Workspace-Admin-Konto

• 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, das Altium Designer SDK, den 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 Gültigkeitsdauer

Der einfachste Weg für den Einstieg. Sie erhalten ein einzelnes Zugriffstoken mit konfigurierbarer Gültigkeitsdauer (bis zu 1 Jahr). Verwenden Sie es direkt in API-Anfragen.

Gut geeignet für: schnelle Erkundung, 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 eingetauscht, das dann in API-Anfragen verwendet wird. Das Refresh-Token selbst hat eine konfigurierbare Gültigkeitsdauer (bis zu 1 Jahr).

Gut geeignet für: automatisierte Integrationen, Hintergrunddienste und alles, was im Produktivbetrieb 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 kennenzulernen, ist über die integrierte Browser-IDE (unterstützt von Nitro). Navigieren Sie zu:

https://{workspace-domain}.altium.com/svc/napi/gateway/graphql/

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

Ihre Anfrage autorisieren

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

Authorization: Bearer {access-token}

Führen Sie Ihre erste Abfrage aus

Eine gute Einstiegsabfrage 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/svc/napi/gateway/voyager/

Nächste Schritte

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

• Siehe Using an Access Token zur Verwendung von Tokens in Code und Skripten

• Siehe Using a Refresh Token für automatisierte Integrationen