APIs
Überblick über die APIs
SDA bietet eine vollständig zugängliche, moderne API-Schicht, mit der Sie jeden Teil der Plattform integrieren, automatisieren und erweitern können. Nahezu alle Funktionen der SDA-Plattform – darunter Geräteverwaltung, Projektoperationen, Ausführung von Pipelines, Identitätsverwaltung und Remote-Engineering – sind über sichere, versionierte APIs verfügbar. Kunden können damit eigene Workflows aufbauen, Engineering-Prozesse automatisieren und SDA in bestehende Unternehmenssysteme und Toolchains einbinden.
Dieser Abschnitt dokumentiert die zentralen APIs von SDA und enthält praxisnahe Beispiele für einen schnellen Einstieg. Die Codebeispiele liegen in gängigen Sprachen wie Python vor; die Muster lassen sich bei Bedarf auf JavaScript, C# und andere Umgebungen übertragen.
Wesentliche API-Kategorien
Asset API
Die Asset API bietet programmatischen Zugriff auf Geräte, Projekte, Ressourcengruppen und zugehörige Metadaten. Externe Systeme können damit Assets in SDA auflisten, abfragen, aktualisieren und orchestrieren – ideal für die Synchronisierung mit einer CMDB, das automatisierte Onboarding von Assets und ein datengestütztes Lifecycle-Management.
Job API
Mit der Job API lösen, überwachen und verwalten Sie betriebliche Aufgaben wie Backups, Deployments, Snapshots, Passwortrotationen und weitere Pipeline-Aktionen. Sie wird häufig für CI/CD-artige Automatisierung, nächtliche Backups und die Anbindung an Ticket- oder Workflow-Systeme genutzt.
Identity API
Die Identity API bietet Zugriff auf Informationen zu Benutzern, Rollen und Berechtigungen. Sie unterstützt die Integration externer Identitätssysteme, eigene Provisionierungs-Workflows und weitergehende Automatisierung rund um Berechtigungen und RBAC-gestützte Abläufe.
IDEaaS API
Die IDEaaS API stellt die Funktionen des browserbasierten Engineerings bereit, sodass externe Werkzeuge oder Orchestratoren Engineering-Sitzungen erstellen, Automatisierungsprojekte öffnen und herstellerspezifische IDEs aus der Ferne bedienen können. Das ermöglicht automatisierte Engineering-Pipelines, entfernte Arbeitsumgebungen und eine tiefe Integration in bestehende DevOps- oder IT-/OT-Plattformen.
Codebeispiele
Damit Sie die SDA-APIs schnell in Ihre Umgebung integrieren können, enthält dieser Abschnitt praxisnahe, durchgängige Beispiele. Sie zeigen, wie Sie sich authentifizieren, Daten abrufen, Pipeline-Aktionen auslösen und externe Anwendungen anbinden.
Jedes Beispiel hebt Best Practices hervor, etwa Token-Verwaltung, Fehlerbehandlung, Paginierung und empfohlene Sicherheitskonfigurationen.