APIs
Overzicht van de APIs
SDA biedt een volledig toegankelijke, moderne API-laag waarmee u elk onderdeel van het platform kunt integreren, automatiseren en uitbreiden. Vrijwel alle mogelijkheden van het SDA-platform — waaronder apparaatbeheer, projectbewerkingen, pipeline-uitvoering, identiteitsbeheer en remote engineering — worden ontsloten via beveiligde, geversioneerde APIs. Hierdoor kunnen klanten aangepaste workflows bouwen, engineeringprocessen automatiseren en SDA integreren in bestaande bedrijfssystemen en toolchains.
Dit hoofdstuk documenteert de kern-APIs die binnen SDA beschikbaar zijn en biedt praktische voorbeelden waarmee u snel aan de slag kunt. Codevoorbeelden zijn opgenomen in veelgebruikte talen zoals Python, met patronen die naar behoefte kunnen worden aangepast voor JavaScript, C# en andere omgevingen.
Belangrijkste API-categorieën
Asset API
De Asset API biedt programmatische toegang tot apparaten, projecten, resourcegroepen en gerelateerde metadata. Externe systemen kunnen hiermee assets binnen SDA opsommen, opvragen, bijwerken en orkestreren, wat de API ideaal maakt voor CMDB-synchronisatie, geautomatiseerde asset-onboarding en datagedreven beheer van de assetlevenscyclus.
Job API
Met de Job API kunt u operationele taken zoals back-ups, deployments, snapshots, wachtwoordrotaties en andere pipeline-acties starten, bewaken en beheren. Deze API wordt vaak gebruikt voor CI/CD-achtige automatisering, nachtelijke back-ups en integratie met ticketing- of workflowsystemen.
Identity API
De Identity API biedt toegang tot informatie over gebruikers, rollen en rechten. Zij ondersteunt integratie met externe identiteitssystemen, aangepaste provisioning-workflows en geavanceerde automatisering rond entitlements en RBAC-gestuurde bewerkingen.
IDEaaS API
De IDEaaS API ontsluit browsergebaseerde engineeringfunctionaliteit, waardoor externe tools of orkestrators engineeringsessies kunnen aanmaken, automatiseringsprojecten kunnen openen en op afstand kunnen werken met leverancierspecifieke IDE's. Dit maakt geautomatiseerde engineeringpipelines, remote workspaces en diepgaande integratie met bestaande DevOps- of IT/OT-platformen mogelijk.
Codevoorbeelden
Om u te helpen SDA-APIs snel in uw omgeving te integreren, bevat dit hoofdstuk praktische, end-to-end voorbeelden. Deze voorbeelden laten zien hoe u zich authenticeert, gegevens ophaalt, pipeline-acties start en integreert met externe applicaties.
Elk voorbeeld belicht best practices zoals tokenbeheer, foutafhandeling, paginering en aanbevolen beveiligingsconfiguraties.