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

Altium 365 API предоставляет программный доступ к данным вашего Workspace — проектам, BOM, компонентам, символам, посадочным местам и многому другому. Это GraphQL API, то есть вы можете запросить именно те данные, которые вам нужны, в рамках одного запроса.

Это руководство поможет вам за считанные минуты перейти от нуля к вашему первому API-вызову.

Предварительные требования

• Workspace в Altium 365

• Учетная запись администратора Workspace

• Учетная запись в Altium Developer Center — портале самообслуживания Altium для разработчиков, где можно присоединиться к программам для доступа к Altium 365 API, Altium Designer SDK, Embeddable Viewer и другим продуктам для разработчиков

Шаг 1: Создайте токен

Для авторизации API-запросов вам нужен токен доступа. Токены создаются в вашем Workspace в разделе Admin → Developer.

При создании токена можно выбрать один из двух следующих вариантов.

Вариант A: долгоживущий токен доступа

Самый простой способ начать работу. Вы получаете один токен доступа с настраиваемым сроком действия (до 1 года). Используйте его напрямую в API-запросах.

Подходит для: быстрого ознакомления, скриптов и интеграций, где приоритетом является простота.

См. Using an Access token для получения подробной информации.

Вариант B: Refresh Token (рекомендуется для production)

Более безопасный подход. Вы получаете refresh token вместе с client ID и client secret. Refresh token программно обменивается на краткоживущий токен доступа, который затем используется в API-запросах. Сам refresh token также имеет настраиваемый срок действия (до 1 года).

Подходит для: автоматизированных интеграций, фоновых сервисов и всего, что работает в production круглосуточно.

См. Using a Refresh Token для описания процесса обмена.

Шаг 2: Выполните свой первый API-запрос

Самый быстрый способ изучить Altium 365 API — использовать встроенную browser IDE (на базе Nitro). Перейдите по адресу:

https://{workspace-domain}.altium.com/svc/napi/gateway/graphql/

Замените {workspace-domain} на фактический домен вашего Workspace (например, mycompany.altium.com).

Авторизуйте ваш запрос

Для всех API-запросов требуется токен доступа, передаваемый в HTTP-заголовке Authorization по схеме Bearer:

Authorization: Bearer {access-token}

Выполните свой первый запрос

Хороший начальный запрос — получить список проектов вашего Workspace:

query {
  desProjects(first: 10) {
    nodes {
      id
      name
      description
    }
  }
}

Вставьте его в IDE, нажмите Run, и в ответе вы должны увидеть проекты вашего Workspace.

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

https://{workspace-domain}.altium.com/svc/napi/gateway/voyager/

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

• Посетите GitHub-организацию AltiumDeveloper, чтобы найти демо-приложения и примеры запросов

• См. Using an Access Token для использования токенов в коде и скриптах

• См. Using a Refresh Token для автоматизированных интеграций