API
Panoramica delle API
SEW mette a disposizione un livello API moderno e completamente accessibile che consente di integrare, automatizzare ed estendere ogni parte della piattaforma. Quasi tutte le funzionalità della piattaforma SEW—tra cui gestione dei dispositivi, operazioni sui progetti, esecuzione delle pipeline, gestione delle identità ed engineering remoto—sono esposte tramite API sicure e versionate. Questo consente ai clienti di creare flussi di lavoro personalizzati, automatizzare i processi di engineering e integrare SEW nei sistemi aziendali e nelle toolchain esistenti.
Questa sezione documenta le API principali disponibili all'interno di SEW e fornisce esempi pratici per iniziare rapidamente. Gli esempi di codice sono forniti in linguaggi comuni come Python, con schemi che possono essere adattati a JavaScript, C# e ad altri ambienti secondo le necessità.
Categorie principali di API
Asset API
L'Asset API fornisce accesso programmatico a dispositivi, progetti, gruppi di risorse e metadati correlati. Consente ai sistemi esterni di elencare, interrogare, aggiornare e orchestrare gli asset all'interno di SEW, risultando ideale per la sincronizzazione con il CMDB, l'onboarding automatizzato degli asset e la gestione del ciclo di vita degli asset basata sui dati.
Job API
La Job API consente di avviare, monitorare e gestire attività operative quali backup, deployment, snapshot, rotazioni delle password e altre azioni di pipeline. Viene comunemente utilizzata per automazioni in stile CI/CD, backup notturni e integrazione con sistemi di ticketing o di workflow.
Identity API
L'Identity API fornisce accesso alle informazioni su utenti, ruoli e autorizzazioni. Supporta l'integrazione con sistemi di identità esterni, flussi di provisioning personalizzati e automazioni avanzate relative ai diritti di accesso e alle operazioni basate su RBAC.
IDEaaS API
L'API IDEaaS espone funzionalità di engineering basate su browser, permettendo a strumenti o orchestratori esterni di creare sessioni di engineering, aprire progetti PLC e interagire in remoto con gli IDE specifici dei singoli produttori. Ciò consente pipeline di engineering automatizzate, workspace remoti e un'integrazione profonda con le piattaforme DevOps o IT/OT esistenti.
Esempi di codice
Per facilitare la rapida integrazione delle API SEW nel proprio ambiente, questa sezione include esempi pratici end-to-end. Tali esempi mostrano come autenticarsi, recuperare dati, avviare azioni di pipeline e integrarsi con applicazioni esterne.
Ogni esempio evidenzia le best practice, come la gestione dei token, la gestione degli errori, la paginazione e le configurazioni di sicurezza consigliate.