API
Prehľad API
SDA poskytuje plne prístupnú, modernú vrstvu API, ktorá umožňuje integrovať, automatizovať a rozširovať každú časť platformy. Takmer všetky schopnosti platformy SDA – vrátane správy zariadení, operácií s projektmi, spúšťania pipeline, správy identít a vzdialeného inžinierstva – sú sprístupnené prostredníctvom zabezpečených, verziovaných API. To zákazníkom umožňuje vytvárať vlastné pracovné postupy, automatizovať inžinierske procesy a integrovať SDA do existujúcich podnikových systémov a nástrojových reťazcov.
Táto časť dokumentuje základné API dostupné v rámci SDA a poskytuje praktické príklady, ktoré vám pomôžu rýchlo začať. Ukážky kódu sú uvedené v bežných jazykoch, ako je Python, pričom použité vzory možno podľa potreby prispôsobiť pre JavaScript, C# a ďalšie prostredia.
Kľúčové kategórie API
Asset API
Asset API poskytuje programový prístup k zariadeniam, projektom, skupinám zdrojov a súvisiacim metadátam. Umožňuje externým systémom vypisovať, dopytovať, aktualizovať a orchestrovať aktíva v rámci SDA, čo z neho robí ideálny nástroj na synchronizáciu s CMDB, automatizované zavádzanie aktív a správu životného cyklu aktív riadenú dátami.
Job API
Job API umožňuje spúšťať, monitorovať a spravovať prevádzkové úlohy, ako sú zálohy, nasadenia, snímky, rotácie hesiel a ďalšie akcie pipeline. Bežne sa používa na automatizáciu v štýle CI/CD, nočné zálohy a integráciu s ticketovacími alebo workflow systémami.
Identity API
Identity API poskytuje prístup k informáciám o používateľoch, rolách a oprávneniach. Podporuje integráciu s externými systémami identít, vlastné provisioning workflow a pokročilú automatizáciu v oblasti oprávnení a operácií riadených RBAC.
IDEaaS API
IDEaaS API sprístupňuje inžinierske schopnosti založené na prehliadači, čo externým nástrojom alebo orchestrátorom umožňuje vytvárať inžinierske relácie, otvárať automatizačné projekty a vzdialene pracovať s IDE špecifickými pre jednotlivých výrobcov. To umožňuje automatizované inžinierske pipeline, vzdialené pracovné priestory a hlbokú integráciu s existujúcimi DevOps alebo IT/OT platformami.
Príklady kódu
Aby ste mohli rýchlo integrovať SDA API do svojho prostredia, táto časť obsahuje praktické, ucelené príklady. Tieto príklady demonštrujú, ako sa autentifikovať, získavať dáta, spúšťať akcie pipeline a integrovať sa s externými aplikáciami.
Každý príklad zdôrazňuje osvedčené postupy, ako je správa tokenov, spracovanie chýb, stránkovanie a odporúčané bezpečnostné konfigurácie.