Краткое руководство по началу работы с API Altium 365

Altium 365 API предоставляет программный доступ к данным вашего рабочего пространства: проектам, спецификациям, компонентам, символам, посадочным местам и многому другому. Это 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, и в ответе появится список проектов вашего рабочего пространства.

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

https://{workspace-subdomain}.365.altium.com/api/voyager

Следующие шаги

• Ознакомьтесь с демонстрационными приложениями и примерами запросов в организации AltiumDeveloper на GitHub

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

• Сведения об автоматизированных интеграциях см. в разделе Использование токена обновления