APIs
Descripción general de las APIs
SEW proporciona una capa de API moderna y totalmente accesible que le permite integrar, automatizar y ampliar cada parte de la plataforma. Casi todas las capacidades de la plataforma SEW —incluidas la gestión de dispositivos, las operaciones de proyectos, la ejecución de pipelines, la gestión de identidades y la ingeniería remota— se exponen mediante APIs seguras y versionadas. Esto permite a los clientes crear flujos de trabajo personalizados, automatizar procesos de ingeniería e integrar SEW en los sistemas empresariales y cadenas de herramientas existentes.
Esta sección documenta las APIs principales disponibles en SEW y ofrece ejemplos prácticos que le ayudarán a comenzar rápidamente. Se incluyen ejemplos de código en lenguajes habituales como Python, con patrones que pueden adaptarse a JavaScript, C# y otros entornos según sea necesario.
Categorías principales de APIs
Asset API
La Asset API proporciona acceso programático a dispositivos, proyectos, grupos de recursos y metadatos relacionados. Permite a los sistemas externos listar, consultar, actualizar y orquestar activos dentro de SEW, lo que la hace ideal para la sincronización con CMDB, la incorporación automatizada de activos y la gestión del ciclo de vida de los activos basada en datos.
Job API
La Job API le permite lanzar, supervisar y gestionar tareas operativas como copias de seguridad, despliegues, snapshots, rotaciones de contraseñas y otras acciones de pipeline. Se utiliza habitualmente para automatización de tipo CI/CD, copias de seguridad nocturnas e integración con sistemas de tickets o de flujos de trabajo.
Identity API
La Identity API proporciona acceso a información sobre usuarios, roles y permisos. Admite la integración con sistemas de identidad externos, flujos de aprovisionamiento personalizados y automatización avanzada en torno a los derechos de acceso y las operaciones basadas en RBAC.
IDEaaS API
La IDEaaS API expone capacidades de ingeniería basadas en navegador, permitiendo a herramientas u orquestadores externos crear sesiones de ingeniería, abrir proyectos de PLC e interactuar de forma remota con los IDE específicos de cada fabricante. Esto posibilita pipelines de ingeniería automatizados, espacios de trabajo remotos y una integración profunda con las plataformas DevOps o IT/OT existentes.
Ejemplos de código
Para ayudarle a integrar rápidamente las APIs de SEW en su entorno, esta sección incluye ejemplos prácticos de extremo a extremo. Estos ejemplos muestran cómo autenticarse, recuperar datos, lanzar acciones de pipeline e integrarse con aplicaciones externas.
Cada ejemplo destaca buenas prácticas como la gestión de tokens, el tratamiento de errores, la paginación y las configuraciones de seguridad recomendadas.