API Altium 365

Updated: мая 21, 2026

Altium 365 API — это GraphQL API, предоставляющий программный доступ к данным вашего 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`
Gov Cloud	`https://use.365-gov.altium.com/api/graphql`	`https://use.365-gov.altium.com/api/files`

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

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

Authorization: Bearer {access-token}

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

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

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

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

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