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

Краткий обзор

Узнайте, как использовать токен доступа для авторизации запросов к API Altium 365 — независимо от того, создаёте ли вы его напрямую или получаете в обмен на токен обновления. В статье рассматриваются заголовок Authorization, пример с curl, срок действия токенов и меры безопасности. Читайте дальше, чтобы уверенно работать с API.

- Используйте формат Bearer для авторизации запросов к API.
- Разберитесь, как истекает срок действия долгосрочных и краткосрочных токенов, как их заменять и какие ошибки возникают при истечении срока действия.
- Узнайте, где не следует хранить токены доступа и почему для длительно работающих интеграций предпочтительнее использовать токены обновления.
Узнайте больше с ИИ:

Токен доступа авторизует запросы к 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.

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

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

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

См. также

 

AI-LocalizedЛокализовано с помощью ИИ
Если вы обнаружили проблему, выделите текст/изображение и нажмитеCtrl + Enter, чтобы отправить нам свой отзыв.
Contents
Contents