API Altium 365
API Altium 365 — это API GraphQL, который предоставляет программный доступ к данным вашего рабочего пространства Altium 365. Он поддерживает операции чтения и записи во всех областях платформы.
Как устроен API
API организован по предметным областям платформы, называемым bounded contexts. Каждый ограниченный контекст охватывает определенную область платформы — ее сущности, операции и бизнес-правила. Имена типов и запросов GraphQL соответствуют соглашениям об именовании, отражающим их принадлежность к предметной области. Это упрощает навигацию по схеме после знакомства с ее структурой.
Основные ограниченные контексты
Ограниченный контекст |
Что он охватывает |
Design |
Проекты печатных плат, принципиальные схемы, варианты, выпуски, пакеты производственных данных |
Library |
Компоненты, условные графические обозначения, посадочные места, детали, запросы на детали, технические описания |
Procurement |
Спецификации, позиции спецификаций, альтернативные детали и детали-заменители |
Platform |
Пользователи, рабочие пространства, организации, определения жизненного цикла, именование ревизий |
Collaboration |
Комментарии, обсуждения, задачи |
Customization |
Рабочие процессы, скрипты, выполнение скриптов |
Дополнительные ограниченные контексты охватывают более специализированные возможности — моделирование устройств, беспроводное обновление прошивки, управление требованиями, встроенное программное обеспечение и проектирование систем. Они доступны через тот же API и следуют тем же соглашениям.
По мере расширения документации для каждого ограниченного контекста будет создан отдельный раздел. Пока для изучения полного графа типов удобно использовать встроенный Voyager — инструмент просмотра схемы.
Конечные точки
Региональные конечные точки
Используйте региональную конечную точку, если вы не работаете с конкретным рабочим пространством — например, чтобы получить список всех рабочих пространств, к которым у пользователя есть доступ, — или при работе с глобальными данными, такими как пользователи и организации.
Регион |
GraphQL |
Файловый сервис |
Voyager (изучение схемы) |
Европа |
|
|
https://eur.365.altium.com/api/voyager |
Запад США |
|
|
https://usw.365.altium.com/api/voyager |
Восток США |
|
|
https://use.365.altium.com/api/voyager |
Азиатско-Тихоокеанский регион |
|
|
https://asp.365.altium.com/api/voyager |
GovCloud |
|
|
https://use.365-gov.altium.com/api/voyager |
Конечные точки рабочего пространства
Для взаимодействия с ресурсами конкретного рабочего пространства рекомендуется начинать с его конечных точек. Конечные точки API используют тот же домен, что и рабочее пространство, и могут быть обнаружены программно — см. пример Получение списка рабочих пространств.
GraphQL |
Файловый сервис |
Voyager (изучение схемы) |
|
|
https://{workspace-domain}/api/voyager |
Изучение схемы
API Altium 365 является самодокументируемым. Два встроенных инструмента доступны непосредственно по URL вашего рабочего пространства:
-
Nitro — браузерная IDE GraphQL для интерактивного написания и выполнения запросов:
https://{workspace-domain}/api/graphql/ -
Voyager — визуальный граф полной схемы, помогающий понять связи между типами:
https://{workspace-domain}/api/voyager/
Аутентификация
Все запросы должны содержать действительный токен доступа:
Authorization: Bearer {access-token}
Подробности см. в разделе Использование токена доступа.
В этом разделе
Локализовано с помощью ИИ