API
Przegląd API
SDA udostępnia w pełni dostępną, nowoczesną warstwę API, która umożliwia integrowanie, automatyzowanie i rozszerzanie każdej części platformy. Niemal wszystkie możliwości platformy SDA — w tym zarządzanie urządzeniami, operacje na projektach, wykonywanie potoków, zarządzanie tożsamością oraz zdalny engineering — są udostępniane poprzez bezpieczne, wersjonowane API. Dzięki temu klienci mogą tworzyć własne przepływy pracy, automatyzować procesy inżynierskie oraz integrować SDA z istniejącymi systemami korporacyjnymi i łańcuchami narzędzi.
Ta sekcja dokumentuje podstawowe API dostępne w SDA oraz zawiera praktyczne przykłady ułatwiające szybki start. Przykłady kodu są dostępne 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 programistyczny 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 SDA, 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, rotacje 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 systemami obiegu 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 możliwości inżynierskie w przeglądarce, pozwalając zewnętrznym narzędziom lub orkiestratorom tworzyć sesje inżynierskie, otwierać projekty automatyki i zdalnie korzystać ze środowisk IDE poszczególnych producentów. Umożliwia to zautomatyzowane potoki inżynierskie, zdalne przestrzenie robocze oraz głęboką integrację z istniejącymi platformami DevOps lub IT/OT.
Przykłady kodu
Aby ułatwić szybką integrację API SDA z Państwa środowiskiem, ta sekcja zawiera praktyczne, kompletne przykłady. Pokazują one, jak przeprowadzić uwierzytelnianie, pobierać dane, wyzwalać działania potoków oraz integrować 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.