APIs
APIs im Überblick
SEW stellt eine vollständig zugängliche, moderne API-Schicht bereit, mit der Sie jeden Teil der Plattform integrieren, automatisieren und erweitern können. Nahezu alle Funktionen der SEW-Plattform – einschließlich Geräteverwaltung, Projektvorgängen, Pipeline-Ausführung, Identitätsverwaltung und Remote-Engineering – werden über sichere, versionierte APIs bereitgestellt. Dadurch können Kunden eigene Workflows erstellen, Engineering-Prozesse automatisieren und SEW in bestehende Unternehmenssysteme und Toolchains integrieren.
Dieser Abschnitt dokumentiert die zentralen APIs, die innerhalb von SEW verfügbar sind, und bietet praktische Beispiele für einen schnellen Einstieg. Codebeispiele liegen in gängigen Sprachen wie Python vor, wobei die Muster nach Bedarf auf JavaScript, C# und andere Umgebungen übertragen werden können.
Wichtige API-Kategorien
Asset API
Die Asset API bietet programmatischen Zugriff auf Geräte, Projekte, Ressourcengruppen und zugehörige Metadaten. Sie ermöglicht externen Systemen das Auflisten, Abfragen, Aktualisieren und Orchestrieren von Assets innerhalb von SEW und eignet sich damit ideal für die CMDB-Synchronisierung, das automatisierte Onboarding von Assets und ein datengetriebenes Asset-Lifecycle-Management.
Job API
Mit der Job API können Sie operative Aufgaben wie Backups, Deployments, Snapshots, Passwortrotationen und andere Pipeline-Aktionen auslösen, überwachen und verwalten. Sie wird üblicherweise für Automatisierung im CI/CD-Stil, nächtliche Backups sowie die Integration mit Ticketing- oder Workflow-Systemen eingesetzt.
Identity API
Die Identity API bietet Zugriff auf Informationen zu Benutzern, Rollen und Berechtigungen. Sie unterstützt die Integration mit externen Identitätssystemen, individuelle Provisionierungs-Workflows und eine erweiterte Automatisierung rund um Berechtigungen und RBAC-gesteuerte Vorgänge.
IDEaaS API
Die IDEaaS API stellt browserbasierte Engineering-Funktionen bereit und ermöglicht externen Tools oder Orchestratoren, Engineering-Sitzungen zu erstellen, PLC-Projekte zu öffnen und herstellerspezifische IDEs aus der Ferne zu bedienen. Damit werden automatisierte Engineering-Pipelines, Remote-Arbeitsumgebungen und eine tiefe Integration in bestehende DevOps- oder IT/OT-Plattformen möglich.
Codebeispiele
Damit Sie die SEW-APIs schnell in Ihre Umgebung integrieren können, enthält dieser Abschnitt praxisnahe End-to-End-Beispiele. Diese Beispiele zeigen, wie Sie sich authentifizieren, Daten abrufen, Pipeline-Aktionen auslösen und die Integration mit externen Anwendungen umsetzen.
Jedes Beispiel hebt Best Practices hervor, etwa Token-Management, Fehlerbehandlung, Pagination und empfohlene Sicherheitskonfigurationen.