API
Przegląd API
SEW udostępnia w pełni dostępną, nowoczesną warstwę API, która pozwala integrować, automatyzować i rozszerzać każdy element platformy. Niemal wszystkie funkcje platformy SEW — w tym zarządzanie urządzeniami, operacje na projektach, wykonywanie potoków, zarządzanie tożsamością oraz zdalne inżynierowanie — są udostępniane poprzez bezpieczne, wersjonowane API. Umożliwia to klientom tworzenie własnych przepływów pracy, automatyzację procesów inżynierskich oraz integrację SEW z istniejącymi systemami korporacyjnymi i łańcuchami narzędzi.
Ta sekcja dokumentuje podstawowe API dostępne w SEW i zawiera praktyczne przykłady, które pomogą szybko rozpocząć pracę. Przykłady kodu zamieszczono w popularnych językach, takich jak Python, przy czym zastosowane wzorce można w razie potrzeby dostosować do JavaScriptu, C# i innych środowisk.
Główne kategorie API
Asset API
Asset API zapewnia programowy dostęp do urządzeń, projektów, grup zasobów i powiązanych metadanych. Umożliwia systemom zewnętrznym wyświetlanie, odpytywanie, aktualizowanie i orkiestrację zasobów w ramach SEW, co czyni je idealnym rozwiązaniem do synchronizacji z CMDB, automatycznego wdrażania zasobów oraz zarządzania cyklem życia zasobów w oparciu o dane.
Job API
Job API pozwala wyzwalać, monitorować i zarządzać zadaniami operacyjnymi, takimi jak kopie zapasowe, wdrożenia, migawki, rotacja haseł i inne działania potoków. Jest ono powszechnie wykorzystywane do automatyzacji w stylu CI/CD, nocnych kopii zapasowych oraz integracji z systemami zgłoszeń lub przepływów pracy.
Identity API
Identity API zapewnia dostęp do informacji o użytkownikach, rolach i uprawnieniach. Wspiera integrację z zewnętrznymi systemami tożsamości, niestandardowe przepływy provisioningu oraz zaawansowaną automatyzację w zakresie uprawnień i operacji opartych na RBAC.
IDEaaS API
IDEaaS API udostępnia funkcje inżynierskie działające w przeglądarce, umożliwiając zewnętrznym narzędziom lub orkiestratorom tworzenie sesji inżynierskich, otwieranie projektów PLC oraz zdalną pracę z IDE poszczególnych producentów. Umożliwia to zautomatyzowane potoki inżynierskie, zdalne środowiska pracy oraz głęboką integrację z istniejącymi platformami DevOps lub IT/OT.
Przykłady kodu
Aby ułatwić szybką integrację API SEW z Państwa środowiskiem, ta sekcja zawiera praktyczne, kompletne przykłady. Pokazują one, jak przeprowadzić uwierzytelnianie, pobrać dane, wyzwolić działania potoków oraz zintegrować się z aplikacjami zewnętrznymi.
Każdy przykład uwypukla najlepsze praktyki, takie jak zarządzanie tokenami, obsługa błędów, paginacja oraz zalecane konfiguracje bezpieczeństwa.