APIs
Vue d'ensemble des APIs
SDA fournit une couche API moderne et entièrement accessible qui vous permet d'intégrer, d'automatiser et d'étendre chaque partie de la plateforme. Presque toutes les fonctionnalités de la plateforme SDA — y compris la gestion des équipements, les opérations sur les projets, l'exécution des pipelines, la gestion des identités et l'ingénierie à distance — sont exposées via des APIs sécurisées et versionnées. Cela permet aux clients de créer des workflows personnalisés, d'automatiser les processus d'ingénierie et d'intégrer SDA dans les systèmes d'entreprise et chaînes d'outils existants.
Cette section documente les APIs principales disponibles dans SDA et fournit des exemples pratiques pour vous aider à démarrer rapidement. Des exemples de code sont fournis dans des langages courants tels que Python, avec des modèles pouvant être adaptés à JavaScript, C# et à d'autres environnements selon les besoins.
Principales catégories d'APIs
Asset API
L'Asset API fournit un accès programmatique aux équipements, projets, groupes de ressources et métadonnées associées. Elle permet aux systèmes externes de lister, interroger, mettre à jour et orchestrer les actifs au sein de SDA, ce qui en fait une solution idéale pour la synchronisation avec une CMDB, l'intégration automatisée des actifs et la gestion du cycle de vie des actifs pilotée par les données.
Job API
La Job API vous permet de déclencher, surveiller et gérer des tâches opérationnelles telles que les sauvegardes, les déploiements, les snapshots, les rotations de mots de passe et d'autres actions de pipeline. Elle est couramment utilisée pour l'automatisation de type CI/CD, les sauvegardes nocturnes et l'intégration avec des systèmes de ticketing ou de workflow.
Identity API
L'Identity API donne accès aux informations relatives aux utilisateurs, aux rôles et aux permissions. Elle prend en charge l'intégration avec des systèmes d'identité externes, les workflows de provisionnement personnalisés et l'automatisation avancée des droits et des opérations pilotées par RBAC.
IDEaaS API
L'IDEaaS API expose les capacités d'ingénierie basées sur navigateur, permettant à des outils externes ou à des orchestrateurs de créer des sessions d'ingénierie, d'ouvrir des projets d'automatisation et d'interagir à distance avec les IDE spécifiques aux fabricants. Cela rend possibles des pipelines d'ingénierie automatisés, des espaces de travail distants et une intégration poussée avec les plateformes DevOps ou IT/OT existantes.
Exemples de code
Pour vous aider à intégrer rapidement les APIs SDA dans votre environnement, cette section propose des exemples pratiques et complets. Ces exemples montrent comment s'authentifier, récupérer des données, déclencher des actions de pipeline et réaliser une intégration avec des applications externes.
Chaque exemple met en évidence les bonnes pratiques telles que la gestion des jetons, la gestion des erreurs, la pagination et les configurations de sécurité recommandées.