API-k
API-k áttekintése
A SEW teljes körűen hozzáférhető, modern API-réteget biztosít, amely lehetővé teszi a platform minden részének integrálását, automatizálását és kiterjesztését. A SEW platform szinte valamennyi képessége – beleértve az eszközkezelést, a projektműveleteket, a folyamatok (pipeline) végrehajtását, az identitáskezelést és a távoli mérnöki munkát – biztonságos, verziózott API-kon keresztül érhető el. Ez lehetővé teszi az ügyfelek számára, hogy egyedi munkafolyamatokat építsenek, mérnöki folyamatokat automatizáljanak, és a SEW-t meglévő vállalati rendszerekbe és eszközláncokba integrálják.
Ez a szakasz a SEW-n belül elérhető alapvető API-kat dokumentálja, és gyakorlati példákat kínál a gyors kezdéshez. A kódpéldák gyakori nyelveken, például Pythonban érhetők el, olyan mintákkal, amelyek szükség szerint JavaScriptre, C#-ra és más környezetekre is adaptálhatók.
Fő API-kategóriák
Asset API
Az Asset API programozott hozzáférést biztosít az eszközökhöz, projektekhez, erőforráscsoportokhoz és a kapcsolódó metaadatokhoz. Lehetővé teszi külső rendszerek számára a SEW-n belüli eszközök listázását, lekérdezését, frissítését és vezénylését, így ideális CMDB-szinkronizációhoz, automatizált eszközbevonáshoz és adatvezérelt eszköz-életciklus-kezeléshez.
Job API
A Job API lehetővé teszi olyan üzemeltetési feladatok indítását, felügyeletét és kezelését, mint a biztonsági mentések, telepítések, pillanatképek, jelszóforgatások és egyéb pipeline-műveletek. Gyakran használják CI/CD-jellegű automatizáláshoz, éjszakai biztonsági mentésekhez, valamint jegykezelő vagy munkafolyamat-rendszerekkel való integrációhoz.
Identity API
Az Identity API hozzáférést biztosít a felhasználói, szerepkör- és jogosultsági információkhoz. Támogatja a külső identitásrendszerekkel való integrációt, az egyedi kiépítési (provisioning) munkafolyamatokat, valamint a jogosultságok és az RBAC-vezérelt műveletek körüli fejlett automatizálást.
IDEaaS API
Az IDEaaS API böngészőalapú mérnöki képességeket tesz elérhetővé, lehetővé téve külső eszközök vagy vezénylők számára mérnöki munkamenetek létrehozását, PLC-projektek megnyitását és a gyártóspecifikus IDE-kkel való távoli interakciót. Ez automatizált mérnöki folyamatokat, távoli munkaterületeket és a meglévő DevOps- vagy IT/OT-platformokkal való mély integrációt tesz lehetővé.
Kódpéldák
Annak érdekében, hogy a SEW API-kat gyorsan integrálhassa környezetébe, ez a szakasz gyakorlati, végponttól végpontig terjedő példákat tartalmaz. Ezek a példák bemutatják a hitelesítést, az adatok lekérését, a pipeline-műveletek indítását és a külső alkalmazásokkal való integrációt.
Minden példa kiemeli az ajánlott gyakorlatokat, például a tokenkezelést, a hibakezelést, a lapozást és az ajánlott biztonsági beállításokat.