API-k
API-k áttekintése
Az SDA teljes körűen elérhető, modern API-réteget biztosít, amellyel a platform minden részét integrálhatja, automatizálhatja és bővítheti. Az SDA platform szinte valamennyi képessége – beleértve az eszközkezelést, a projektműveleteket, a pipeline-ok 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 egyedi munkafolyamatok kialakítását, mérnöki folyamatok automatizálását, valamint az SDA integrálását a meglévő vállalati rendszerekbe és eszközláncokba.
Ez a szakasz dokumentálja az SDA-n belül elérhető alapvető API-kat, és gyakorlati példákkal segíti a gyors kezdést. A kódminták elterjedt 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 átültethető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 az SDA-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özbevezetéshez és adatvezérelt eszköz-életciklus-kezeléshez.
Job API
A Job API lehetővé teszi olyan üzemeltetési feladatok elindítását, felügyeletét és kezelését, mint a biztonsági mentések, telepítések, pillanatfelvételek, jelszóforgatások és egyéb pipeline-műveletek. Jellemzően CI/CD-jellegű automatizáláshoz, éjszakai mentésekhez, valamint jegykezelő vagy munkafolyamat-rendszerekkel való integrációhoz használják.
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 munkafolyamatokat, valamint a jogosultságok és az RBAC-alapú 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, automatizálási projektek megnyitását és a gyártóspecifikus IDE-kkel való távoli interakciót. Ez lehetővé teszi automatizált mérnöki pipeline-ok, távoli munkaterületek kialakítását és a meglévő DevOps- vagy IT/OT-platformokkal való mély integrációt.
Kódpéldák
Az SDA API-k környezetébe történő gyors integrálásának megkönnyítése érdekében 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 a javasolt biztonsági konfigurációkat.