Preskočiť na hlavný obsah

API

Prehľad API​

SEW poskytuje plne dostupnú, modernú vrstvu API, ktorá umožňuje integrovať, automatizovať a rozširovať každú časť platformy. Takmer všetky funkcie platformy SEW – vrátane správy zariadení, operácií s projektmi, spúšťania pipeline, správy identít a vzdialeného inženýringu – sú sprístupnené prostredníctvom bezpečných, verziovaných API. To zákazníkom umožňuje vytvárať vlastné pracovné postupy, automatizovať inženierske procesy a integrovať SEW do existujúcich podnikových systémov a nástrojových sád.

Táto časť dokumentuje základné API dostupné v rámci SEW a poskytuje praktické príklady, ktoré vám pomôžu rýchlo začať. Ukážky kódu sú zahrnuté v bežných jazykoch, ako je Python, so vzormi, ktoré je možné 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 SEW, čo ho robí ideálnym na synchronizáciu CMDB, automatizované uvádzanie aktív do prevádzky a správu životného cyklu aktív riadenú dátami.

Job API​

Job API vám umožňuje spúšťať, monitorovať a riadiť prevádzkové úlohy, ako sú zálohy, nasadenia, snapshoty, 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 so systémami na správu tiketov alebo pracovných postupov.

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é procesy poskytovania (provisioning) a pokročilú automatizáciu v oblasti oprávnení a operácií riadených RBAC.

IDEaaS API​

IDEaaS API sprístupňuje inženierske funkcie na báze prehliadača, čo umožňuje externým nástrojom alebo orchestrátorom vytvárať inženierske sedenia, otvárať PLC projekty a vzdialene pracovať s IDE špecifickými pre jednotlivých výrobcov. To umožňuje automatizované inženierske pipeline, vzdialené pracovné prostredia a hlbokú integráciu s existujúcimi DevOps alebo IT/OT platformami.


Ukážky kódu​

Aby ste mohli API SEW rýchlo integrovať do svojho prostredia, táto časť obsahuje praktické, komplexné 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 poukazuje na osvedčené postupy, ako je správa tokenov, spracovanie chýb, stránkovanie a odporúčané konfigurácie zabezpečenia.