Connecter un Workspace Altium 365 à des systèmes externes

Design data in Altium 365 does not have to stay in Altium 365. The Altium 365 API gives external systems programmatic access to Workspace data – for reading, writing, and reacting to changes.

L’API Altium 365 fournit un accès côté serveur à l’ensemble des entités du Workspace : composants, conceptions, nomenclatures (BOM), métadonnées de projet, utilisateurs, autorisations et états de cycle de vie. Les systèmes externes peuvent interroger ces données, envoyer des mises à jour et intégrer les événements du Workspace Altium dans des workflows d’entreprise plus larges. L’accès repose sur des jetons ; les opérations s’exécutent côté serveur sans qu’il soit nécessaire qu’Altium Designer soit ouvert ou qu’un utilisateur soit présent.

Il s’agit du point d’intégration approprié pour tout cas d’usage où un système externe doit échanger des données avec Altium 365 de manière programmatique – tableaux de bord, synchronisation ERP, pipelines de reporting personnalisés, systèmes d’audit et automatisations exécutées en dehors de l’environnement de conception.

Modèles d’intégration courants

• Data extraction and reporting – extraire les données des composants, le contenu des BOM, les métadonnées de projet et l’état du cycle de vie vers des systèmes externes de reporting, des tableaux de bord ou des entrepôts de données. Utile pour la visibilité du management de l’ingénierie, la planification des achats et le reporting de conformité nécessitant des données d’Altium mais hébergées dans un système distinct.

• ERP and inventory synchronization – envoyer vers l’ERP les changements de cycle de vie des composants et les listes de pièces approuvées depuis Altium 365. Rapatrier dans Altium les matériaux approuvés et les données d’inventaire pour affichage dans l’environnement de conception. L’API constitue la couche de synchronisation entre les deux systèmes.

• Automation pipelines – déclencher des actions en aval lorsque des événements se produisent dans Altium 365 – une conception est publiée, l’état du cycle de vie d’un composant change, une revue de projet est terminée. L’API permet aux systèmes d’orchestration externes de réagir à l’état du Workspace Altium sans interrogation périodique ni déclencheurs manuels.

• Custom tooling and portals – créer des outils internes qui exposent les données Altium dans des contextes où l’interface complète du Workspace n’est pas adaptée – un portail d’approbation des composants, un tableau de bord d’état des publications, une vue achats n’affichant que les données nécessaires aux achats. L’API fournit la couche de données ; votre outil fournit l’interface.

• User and permission management – gérer de manière programmatique les membres du Workspace, les niveaux d’accès et la structure des équipes. Utile pour les organisations où le provisionnement du Workspace Altium doit rester synchronisé avec un système central d’identité ou de RH.

Ce que l’API ne remplace pas

L’API Altium 365 donne accès aux données et aux opérations au niveau du Workspace. Elle n’expose pas le modèle de l’éditeur de conception – primitives PCB, objets schématiques, topologie du net – qui réside dans Altium Designer. Pour les cas d’usage nécessitant l’accès à des données au niveau de la conception pendant une session d’édition active, le SDK Altium Designer est l’outil approprié. Pour les cas d’usage nécessitant l’accès aux primitives de conception PCB pour un traitement en aval, l’API de données de conception Nexar fournit une voie d’accès distincte.

Considérations sur l’approche d’intégration

• Token management – l’API utilise une authentification par jeton. Les jetons d’accès personnels sont associés à l’utilisateur et attribuent les actions à cet utilisateur. Les jetons d’application sont associés à une application nommée et conviennent aux pipelines automatisés et aux intégrations de serveur à serveur. Faites votre choix selon que l’intégration représente l’action d’une personne ou celle d’un système.

• Eventual consistency – les modifications des données du Workspace se propagent de manière asynchrone dans certains cas. Les intégrations qui dépendent d’un état en temps réel doivent tenir compte de la latence entre le moment où une modification se produit et celui où elle devient visible via l’API.

• Error handling and retries – les intégrations de production doivent implémenter une logique de nouvelle tentative avec temporisation progressive en cas de défaillances temporaires. Les opérations du Workspace sont durables, mais les conditions réseau et les limites de débit ne sont pas garanties.