Начало работы

Данная инструкция подходит для быстрого старта, если у вас нет необходимости в пошаговой стартовой инструкции, то переходите по древу документации.

⚠️

Документация находится в разработке и может содержать недостающую информацию, обращайтесь к разработчику за подробностями.

Для продолжения выберите подходящий для вас способ авторизации:

Authorization Code требует настройки сервера и подходят для приложений, где безопасность токена является критичной (токен КФУ Auth будет открыт только для сервера), но вам необходимо будет работать с токеном на стороне сервера, при этом вы будете производить свой токен доступа.
Implicit не требует настройки сервера и подходят для одностраничных приложений, где безопасность токена не является критичной (токен КФУ Auth будет открыт для браузера).

Нажмите Редактировать и укажите редирект(ы) на ваш сервер (Callback URL).
Выберите необходимый вам тип авторизации
Включите необходимые вам элементы (напр, read).
Если вам необходимы привилегированные элементы, то запросите их у администратора и обоснуйте причину.
Сохраните изменения и вернитесь на страницу приложения.
Откройте генератор OAuth2 URL (Сгенерировать ссылку для OAuth2)
Выберите Callback URL и элементы, необходимые для авторизации в вашем приложении/сайте
Скопируйте ссылку и сохраните её.

Используйте Base URL https://auth.kpfu.tyuop.ru/api/v1/ для отправки запросов к API.

На странице приложения нажмите Сбросить Client Secret и сохраните его.
Добавьте в ваше приложение ссылку на страницу авторизации, скопированную ранее (по желанию можете сделать открытие во всплывающем окне, например <a href="..." target="_blank">...</a>).
Создайте API-endpoint на своём сервере для получения exchange-кодов (Callback URL)

Для обмена кода на токен используйте адрес https://auth.kpfu.tyuop.ru/api/oauth/token. Вы получите примерно такой ответ:

{
  "access_token": "...",
  "token_type": "Bearer",
  "expires_in": 86400
}

Используйте полученный токен для работы с API в формате Bearer {access_token}. Подробнее на странице авторизации.

Для получения информации о пользователе вы можете использовать endpoint /users/@me

Создайте свой токен для сохранения сессии пользователя в вашем приложении/сайте.
После успешной авторизации перенаправьте пользователя на страницу вашего сайта (либо закройте вкладку, если это всплывающее окно)