Использование токена доступа

Токен доступа авторизует запросы к API Altium 365. Его необходимо включать в каждый запрос в качестве Bearer-токена в заголовке Authorization.

Токены доступа можно получить двумя способами:

• Directly – создав долгоживущий токен доступа в разделе Admin → Developer

• Via exchange – использовав токен обновления для создания короткоживущего токена доступа (он не будет отображаться в разделе Admin → Developer)

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

Заголовок авторизации

Authorization: Bearer {access-token}

Пример: curl

curl -X POST https://{workspace-domain}/api/graphql/ \
  -H "Authorization: Bearer {access-token}" \
  -H "Content-Type: application/json" \
  -d '{"query": "{ desProjects(first: 5) { nodes { id name } } }"}'

Срок действия токенов

Long-lived access tokens истекают по окончании срока действия, заданного при создании (до 1 года). После этого необходимо создать новый токен в разделе Admin → Developer.

Short-lived access tokens (полученные путем обмена токена обновления) истекают через короткое время. В этом случае повторно обменяйте токен обновления, чтобы получить новый токен доступа — см. Использование токена обновления.

При использовании токена с истекшим сроком действия запросы к API возвращают 401 Unauthorized или 200 OK с кодом ошибки AuthExpiredToken в ответе GraphQL.

Безопасность

• Не встраивайте токены доступа в клиентский код и не сохраняйте их в системе контроля версий.

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

См. также

• Использование токена обновления