API:er
Översikt över API:er
SDA 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 SDA-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 bygga anpassade arbetsflöden, automatisera engineeringprocesser och integrera SDA i befintliga företagssystem och verktygskedjor.
Detta avsnitt dokumenterar de centrala API:er som finns tillgängliga inom SDA och ger praktiska exempel som hjälper dig att komma igång snabbt. Kodexempel ingår i vanliga språk såsom Python, med mönster som vid behov kan anpassas till JavaScript, C# och andra miljöer.
Viktiga API-kategorier
Asset API
Asset API ger programmatisk åtkomst till enheter, projekt, resursgrupper och tillhörande metadata. Det gör det möjligt för externa system att lista, söka, uppdatera och orkestrera tillgångar inom SDA, 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 utlösa, övervaka och hantera operativa uppgifter såsom säkerhetskopieringar, driftsättningar, ögonblicksbilder, lösenordsrotationer och andra pipelineåtgärder. Det används vanligen 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, anpassade 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 automationsprojekt 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 SDA:s 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, utlöser pipelineåtgärder och integrerar med externa applikationer.
Varje exempel lyfter fram bästa praxis såsom tokenhantering, felhantering, paginering och rekommenderade säkerhetskonfigurationer.