API:er
Översikt över API:er
SEW tillhandahåller ett fullt tillgängligt, modernt API-lager som gör det möjligt att integrera, automatisera och utöka varje del av plattformen. Nästan alla funktioner i SEW-plattformen – inklusive enhetshantering, projektåtgärder, pipelinekörning, identitetshantering och fjärrengineering – exponeras via säkra, versionshanterade API:er. Detta gör det möjligt för kunder att skapa egna arbetsflöden, automatisera engineeringprocesser och integrera SEW i befintliga företagssystem och verktygskedjor.
Detta avsnitt dokumenterar de centrala API:er som är tillgängliga inom SEW och innehåller praktiska exempel som hjälper dig att komma igång snabbt. Kodexempel finns i vanliga språk såsom Python, med mönster som kan anpassas till JavaScript, C# och andra miljöer efter behov.
Viktiga API-kategorier
Asset API
Asset API ger programmatisk åtkomst till enheter, projekt, resursgrupper och relaterade metadata. Det gör det möjligt för externa system att lista, söka, uppdatera och orkestrera tillgångar inom SEW, vilket gör det idealiskt för CMDB-synkronisering, automatiserad onboarding av tillgångar och datadriven livscykelhantering av tillgångar.
Job API
Job API låter dig starta, övervaka och hantera operativa uppgifter såsom säkerhetskopieringar, driftsättningar, snapshots, lösenordsrotationer och andra pipelineåtgärder. Det används ofta för automatisering i CI/CD-stil, nattliga säkerhetskopieringar och integration med ärendehanterings- eller arbetsflödessystem.
Identity API
Identity API ger åtkomst till information om användare, roller och behörigheter. Det stöder integration med externa identitetssystem, egna provisioneringsflöden och avancerad automatisering kring rättigheter och RBAC-drivna åtgärder.
IDEaaS API
IDEaaS API exponerar webbläsarbaserade engineeringfunktioner och gör det möjligt för externa verktyg eller orkestrerare att skapa engineeringsessioner, öppna PLC-projekt och interagera med leverantörsspecifika IDE:er på distans. Detta möjliggör automatiserade engineeringpipelines, fjärrarbetsytor och djup integration med befintliga DevOps- eller IT/OT-plattformar.
Kodexempel
För att hjälpa dig att snabbt integrera SEW-API:er i din miljö innehåller detta avsnitt praktiska exempel från början till slut. Dessa exempel visar hur du autentiserar, hämtar data, startar pipelineåtgärder och integrerar med externa applikationer.
Varje exempel belyser bästa praxis såsom tokenhantering, felhantering, paginering och rekommenderade säkerhetskonfigurationer.