Краткое руководство по началу работы с API Altium 365
Краткий обзор
- Ознакомьтесь с предварительными требованиями и выберите между долгосрочным токеном доступа и токеном обновления.
- Авторизуйте запрос и выполните запрос GraphQL, чтобы получить список проектов вашего рабочего пространства.
- Найдите справочник по API, визуальный обозреватель схемы и примеры приложений для дальнейшей работы.
Altium 365 API предоставляет программный доступ к данным вашего рабочего пространства: проектам, спецификациям (BOM), компонентам, условным графическим обозначениям, посадочным местам и многому другому. Это API на основе GraphQL, поэтому вы можете получить именно те данные, которые вам нужны, одним запросом.
Это руководство поможет вам с нуля выполнить первый вызов API всего за несколько минут.
Предварительные требования
-
Рабочее пространство Altium 365
-
Учетная запись администратора рабочего пространства
-
Учетная запись на Altium Developer Center – портале самообслуживания Altium для разработчиков, где можно зарегистрироваться в программах доступа к Altium 365 API, Altium Designer SDK, Embeddable Viewer и другим продуктам для разработчиков
Шаг 1. Создайте токен
Для авторизации запросов к API необходим токен доступа. Токены создаются в вашем рабочем пространстве в разделе Admin → Developer.
При создании токена можно выбрать один из двух вариантов.
Вариант A. Долгоживущий токен доступа
Самый простой способ начать работу. Вы получаете один токен доступа с настраиваемым сроком действия (до 1 года). Используйте его непосредственно в запросах к API.
Подходит для быстрого знакомства, скриптов и интеграций, в которых простота важнее всего.
Подробнее см. в разделе Использование токена доступа.
Вариант B. Токен обновления (рекомендуется для промышленной эксплуатации)
Более безопасный подход. Вы получаете refresh token вместе с client ID и client secret. Токен обновления программно обменивается на короткоживущий токен доступа, который затем используется в запросах к API. Срок действия самого токена обновления можно настроить (до 1 года).
Подходит для автоматизированных интеграций, фоновых служб и любых решений, работающих в промышленной среде круглосуточно.
Процедура обмена описана в разделе Использование токена обновления.
Шаг 2. Выполните первый запрос к API
Самый быстрый способ познакомиться с Altium 365 API — воспользоваться встроенной браузерной IDE (на базе Nitro). Перейдите по адресу:
https://{workspace-subdomain}.365.altium.com/api/graphql/
Замените {workspace-subdomain} фактическим поддоменом вашего рабочего пространства, чтобы получить, например, https://my-company.365.altium.com/api/graphql.
Авторизуйте запрос
Для всех запросов к API требуется токен доступа, передаваемый в HTTP-заголовке Authorization с использованием схемы Bearer:
Authorization: Bearer {access-token}
Выполните первый запрос
Для начала удобно запросить список проектов вашего рабочего пространства:
query {
desProjects(first: 10) {
nodes {
id
name
description
}
}
}
Вставьте запрос в IDE, нажмите Run, и в ответе вы увидите проекты вашего рабочего пространства.
Каждое поле этого запроса описано в Справочнике Altium 365 API. Доступные фильтры, аргументы сортировки и постраничного вывода см. в desProjects.
Также вы можете просмотреть полную схему API в наглядном виде по адресу:
https://{workspace-subdomain}.365.altium.com/api/voyager
Дальнейшие шаги
-
Изучите Справочник Altium 365 API — все запросы, мутации и типы, сгруппированные по ограниченным контекстам
-
См. раздел Использование токена доступа, чтобы узнать о применении токенов в коде и скриптах
-
См. раздел Использование токена обновления для автоматизированных интеграций
-
Клонируйте platform-api-first-query, чтобы получить приложение «Hello Workspace» и примеры сценариев использования на нескольких языках
-
Разрабатываете приложение с входом пользователей в систему? Используйте библиотеки аутентификации Altium.
-
- Посетите страницу организации AltiumDeveloper на GitHub, чтобы найти дополнительные SDK и демонстрационные приложения.