Подключение Workspace Altium 365 к внешним системам

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.

API Altium 365 предоставляет серверный доступ ко всему набору сущностей Workspace: компонентам, проектам, BOM, метаданным проектов, пользователям, разрешениям и состояниям жизненного цикла. Внешние системы могут запрашивать эти данные, отправлять обновления и встраивать события Altium Workspace в более широкие корпоративные процессы. Доступ осуществляется на основе токенов; операции выполняются на стороне сервера и не требуют, чтобы Altium Designer был открыт или чтобы присутствовал пользователь.

Это правильная точка интеграции для любых сценариев, в которых внешней системе нужно программно обмениваться данными с Altium 365: панели мониторинга, синхронизация с ERP, пользовательские конвейеры отчетности, системы аудита и автоматизация, работающая вне среды проектирования.

Типовые шаблоны интеграции

• Data extraction and reporting – выгрузка данных о компонентах, содержимого BOM, метаданных проектов и состояний жизненного цикла во внешние системы отчетности, панели мониторинга или хранилища данных. Это полезно для прозрачности в инженерном менеджменте, планирования закупок и отчетности по соответствию требованиям, когда данные нужны из Altium, но используются в отдельной системе.

• ERP and inventory synchronization – передача изменений жизненного цикла компонентов и списков утвержденных компонентов из Altium 365 в ERP. Загрузка утвержденных материалов и данных о запасах в Altium для отображения в среде проектирования. API выступает в роли слоя синхронизации между двумя системами.

• Automation pipelines – запуск последующих действий, когда в Altium 365 происходят события – выпускается релиз проекта, изменяется состояние жизненного цикла компонента, завершается проверка проекта. API позволяет внешним системам оркестрации реагировать на состояние Altium Workspace без опроса или ручных триггеров.

• Custom tooling and portals – создание внутренних инструментов, которые показывают данные Altium в контекстах, где полный интерфейс Workspace неуместен – портал утверждения компонентов, панель статуса релизов, представление для закупок, где отображаются только нужные отделу закупок данные. API предоставляет слой данных; ваш инструмент предоставляет интерфейс.

• User and permission management – программное управление членством в Workspace, уровнями доступа и структурой команд. Это полезно для организаций, где настройка Altium Workspace должна оставаться синхронизированной с централизованной системой идентификации или HR-системой.

Что API не заменяет

API Altium 365 предоставляет доступ к данным и операциям на уровне Workspace. Он не раскрывает модель редактора проекта – PCB-примитивы, объекты схем, топологию цепей, – которая находится внутри Altium Designer. Для сценариев, где нужен доступ к данным уровня проекта во время активной сессии редактирования, подходящим инструментом является SDK Altium Designer. Для сценариев, где требуется доступ к примитивам PCB для последующей обработки, API проектных данных Nexar предоставляет отдельный путь доступа.

Что учитывать при выборе подхода к интеграции

• Token management – API использует аутентификацию на основе токенов. Персональные токены доступа привязаны к пользователю и приписывают действия этому пользователю. Токены приложений привязаны к именованному приложению и подходят для автоматизированных конвейеров и серверных интеграций. Выбор зависит от того, представляет ли интеграция действия человека или действия системы.

• Eventual consistency – в некоторых случаях изменения данных Workspace распространяются асинхронно. Интеграции, зависящие от состояния в реальном времени, должны учитывать задержку между моментом изменения и его появлением через API.

• Error handling and retries – для производственных интеграций следует реализовать логику повторных попыток с backoff при временных сбоях. Операции Workspace надежны, но сетевые условия и ограничения по частоте запросов не гарантируются.