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

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

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

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

• Via exchange – при использовании refresh-токена для генерации краткоживущего токена доступа

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

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

Authorization: Bearer {access-token}

Пример: curl

curl -X POST https://{workspace-domain}/svc/napi/gateway/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 (полученные через обмен refresh-токена) истекают через короткий промежуток времени. Когда это произойдет, снова выполните обмен refresh-токена, чтобы получить новый токен — см. Использование refresh-токена.

Просроченный токен приводит к тому, что API-запросы возвращают 401 Unauthorized.

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

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

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

См. также

• Использование refresh-токена