Altium 365 API

Updated: августа 26, 2026

Altium 365 API — это API GraphQL, которое предоставляет программный доступ к данным вашего Workspace в Altium 365. Оно поддерживает как операции чтения, так и записи по всей платформе.

New to Altium 365 API? Начните с краткого руководства, чтобы за несколько минут создать свой первый токен и выполнить первый API-вызов.

Как организован API

API структурирован вокруг доменных областей платформы, известных как bounded contexts. Каждый ограниченный контекст охватывает определенную область платформы — ее сущности, операции и бизнес-правила. Имена типов и запросов GraphQL соответствуют соглашениям об именовании, отражающим доменную область, к которой они относятся, что упрощает навигацию по схеме, когда вы освоитесь со структурой.

Основные ограниченные контексты

Ограниченный контекст	Что охватывает
Design	Проекты PCB, схемы, варианты, релизы, производственные пакеты
Library	Компоненты, символы, посадочные места, детали, запросы на детали, таблицы данных
Procurement	Спецификации материалов, элементы BOM, альтернативные и заменяющие детали
Platform	Пользователи, Workspaces, организации, определения жизненного цикла, именование ревизий
Collaboration	Комментарии, цепочки комментариев, задачи
Customization	Рабочие процессы, скрипты, выполнения скриптов

Дополнительные ограниченные контексты охватывают более специализированные возможности — моделирование устройств, обновления прошивки по воздуху, управление требованиями, встроенное ПО и системное проектирование. Они доступны через тот же API и следуют тем же соглашениям.

По мере расширения охвата для каждого ограниченного контекста будет создан отдельный раздел документации. Встроенный браузер схем Voyager пока является хорошим способом изучить полный граф типов.

Изучение схемы

Altium 365 API самодокументируемый. Два встроенных инструмента доступны непосредственно по URL вашего Workspace:

Nitro – браузерная GraphQL IDE для интерактивного написания и выполнения запросов:
```
https://{workspace-domain}/api/graphql/
```
Voyager – визуальный граф полной схемы, полезный для понимания связей между типами:
```
https://{workspace-domain}/api/voyager/
```

Конечные точки

Конечная точка Workspace

Для большинства интеграций используйте конечную точку Workspace. Она ориентирована на конкретный Workspace и рекомендуется как отправная точка:

	GraphQL	Сервис файлов
Workspace	`https://{workspace-domain}/api/graphql`	`https://{workspace-domain}/api/files`

Региональные конечные точки

Используйте региональную конечную точку, когда у вас нет Workspace в области видимости — например, чтобы вывести список всех Workspaces, к которым у пользователя есть доступ, — или при работе с глобальными данными, такими как пользователи и организации.

Регион	GraphQL	Сервис файлов
Европа	`https://eur.365.altium.com/api/graphql`	`https://eur.365.altium.com/api/files`
Запад США	`https://usw.365.altium.com/api/graphql`	`https://usw.365.altium.com/api/files`
Восток США	`https://use.365.altium.com/api/graphql`	`https://use.365.altium.com/api/files`
Азиатско-Тихоокеанский регион	`https://asp.365.altium.com/api/graphql`	`https://asp.365.altium.com/api/files`
GovCloud	`https://use.365-gov.altium.com/api/graphql`	`https://use.365-gov.altium.com/api/files`

Аутентификация

Все запросы должны включать действительный токен доступа:

Authorization: Bearer {access-token}

Подробности см. в разделе Использование токена доступа .

В этом разделе

Версия для печати

Локализовано с помощью ИИ

Если вы обнаружили проблему, выделите текст/изображение и нажмитеCtrl + Enter, чтобы отправить нам свой отзыв.