API Altium 365
Краткий обзор
- Узнайте, как возможности API распределены по предметным областям платформы: проектирование, библиотеки, закупки и другие.
- Разберитесь, какие конечные точки использовать для ресурсов конкретного рабочего пространства и для глобальных данных.
- Найдите инструменты для изучения схемы, требования к токенам доступа, а также ссылки на краткое руководство по началу работы и справочник API.
Altium 365 API — это API на основе GraphQL, который предоставляет программный доступ к данным вашего рабочего пространства Altium 365. Он поддерживает операции чтения и записи во всех областях платформы.
Как устроен API
API организован по предметным областям платформы, которые называются bounded contexts. Каждый ограниченный контекст охватывает определенную область платформы — ее сущности, операции и бизнес-правила. Имена типов и запросов GraphQL следуют соглашениям об именовании, отражающим их принадлежность к предметной области. Это упрощает навигацию по схеме после знакомства с ее структурой.
Основные ограниченные контексты
Ограниченный контекст |
Что охватывает |
Design |
Проекты печатных плат, схемы, варианты исполнения, выпуски, пакеты производственных данных |
Library |
Компоненты, условные графические обозначения, посадочные места, изделия, запросы на создание компонентов, технические описания |
Procurement |
Спецификации, позиции спецификаций, альтернативные изделия и изделия-замены |
Platform |
Пользователи, рабочие пространства, организации, определения жизненных циклов, правила именования ревизий |
Collaboration |
Комментарии, ветки комментариев, задачи |
Customization |
Рабочие процессы, скрипты, запуски скриптов |
Дополнительные ограниченные контексты охватывают более специализированные возможности — моделирование устройств, беспроводное обновление прошивки, управление требованиями, встраиваемое ПО и проектирование систем. Они доступны через тот же API и следуют тем же соглашениям.
Каждому ограниченному контексту посвящен отдельный раздел в справочнике Altium 365 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 Reference — справочник Altium 365 API по всей схеме с навигацией, поиском и примерами
-
Nitro — браузерная среда разработки GraphQL для интерактивного написания и выполнения запросов:
https://{workspace-domain}/api/graphql/ -
Voyager — визуальный граф полной схемы, помогающий понять связи между типами:
https://{workspace-domain}/api/voyager/
Аутентификация
Все запросы должны содержать действительный токен доступа:
Authorization: Bearer {access-token}
Подробнее см. в разделе «Использование токена доступа».
Связанные ресурсы
-
Справочник Altium 365 API — полный справочник по GraphQL.
-
Справочник Altium 365 API — llms.txt — машиночитаемый указатель справочника для ИИ-помощников по программированию.
-
Библиотеки аутентификации Altium — клиентские библиотеки OAuth2/OIDC + PKCE для входа пользователей в систему.
-
Altium Developer на GitHub — SDK, примеры и исходные файлы документации.
В этом разделе