APIs
Descripción general de las APIs
SDA proporciona una capa de API moderna y totalmente accesible que le permite integrar, automatizar y ampliar cada parte de la plataforma. Prácticamente todas las capacidades de la plataforma SDA —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 a través de APIs seguras y versionadas. Esto permite a los clientes crear flujos de trabajo personalizados, automatizar procesos de ingeniería e integrar SDA en sistemas empresariales y cadenas de herramientas existentes.
Esta sección documenta las APIs principales disponibles en SDA y ofrece ejemplos prácticos para ayudarle a empezar 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 que sistemas externos listen, consulten, actualicen y orquesten activos dentro de SDA, 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 activos basada en datos.
Job API
La Job API le permite activar, 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 estilo 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 de usuarios, roles y permisos. Admite la integración con sistemas de identidad externos, flujos de aprovisionamiento personalizados y automatización avanzada en torno a derechos de acceso y operaciones basadas en RBAC.
IDEaaS API
La IDEaaS API expone capacidades de ingeniería basadas en navegador, permitiendo que herramientas u orquestadores externos creen sesiones de ingeniería, abran proyectos de automatización e interactúen de forma remota con IDEs específicos de cada fabricante. Esto habilita pipelines de ingeniería automatizados, espacios de trabajo remotos y una integración profunda con plataformas DevOps o IT/OT existentes.
Ejemplos de código
Para ayudarle a integrar rápidamente las APIs de SDA en su entorno, esta sección incluye ejemplos prácticos de extremo a extremo. Estos ejemplos muestran cómo autenticarse, recuperar datos, activar acciones de pipeline e integrarse con aplicaciones externas.
Cada ejemplo destaca buenas prácticas como la gestión de tokens, el manejo de errores, la paginación y las configuraciones de seguridad recomendadas.