API's
Overzicht van API's
SEW biedt een volledig toegankelijke, moderne API-laag waarmee u elk onderdeel van het platform kunt integreren, automatiseren en uitbreiden. Vrijwel alle mogelijkheden van het SEW-platform — waaronder apparaatbeheer, projectbewerkingen, pipeline-uitvoering, identiteitsbeheer en remote engineering — worden beschikbaar gesteld via beveiligde, geversioneerde API's. Hierdoor kunnen klanten eigen workflows bouwen, engineeringprocessen automatiseren en SEW integreren in bestaande enterprisesystemen en toolchains.
Dit hoofdstuk documenteert de kern-API's die binnen SEW beschikbaar zijn en biedt praktische voorbeelden om u snel op weg te helpen. Codevoorbeelden zijn opgenomen in veelgebruikte talen zoals Python, met patronen die naar behoefte kunnen worden aangepast aan 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 SEW opvragen, weergeven, bijwerken en orkestreren, waardoor de API uitermate geschikt is voor CMDB-synchronisatie, geautomatiseerde asset-onboarding en datagestuurd 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, monitoren en beheren. Deze API wordt veelal gebruikt voor automatisering in CI/CD-stijl, nachtelijke back-ups en integratie met ticketing- of workflowsystemen.
Identity API
De Identity API geeft toegang tot informatie over gebruikers, rollen en rechten. De API ondersteunt integratie met externe identiteitssystemen, aangepaste provisioning-workflows en geavanceerde automatisering rond entitlements en RBAC-gestuurde bewerkingen.
IDEaaS API
De IDEaaS API stelt browsergebaseerde engineeringfunctionaliteit beschikbaar, waardoor externe tools of orkestrators engineeringsessies kunnen aanmaken, PLC-projecten kunnen openen en op afstand met leverancierspecifieke IDE's kunnen werken. Dit maakt geautomatiseerde engineering-pipelines, remote workspaces en diepgaande integratie met bestaande DevOps- of IT/OT-platforms mogelijk.
Codevoorbeelden
Om u te helpen SEW-API's snel in uw omgeving te integreren, bevat dit hoofdstuk praktische, end-to-end voorbeelden. Deze voorbeelden laten zien hoe u zich authenticeert, gegevens opvraagt, pipeline-acties start en integreert met externe applicaties.
Elk voorbeeld belicht best practices zoals tokenbeheer, foutafhandeling, paginering en aanbevolen beveiligingsconfiguraties.