API поддерживает два способа авторизации. Оба способа используют один и тот же базовый адрес и одни и те же пути операций; различаются субъект запроса и объём доступных сведений.
| ПРИЗНАК | ТОКЕН API | ВОЙТИ ЧЕРЕЗ QAIRU |
|---|---|---|
| Субъект запроса | Внешняя информационная система | Студент, предоставивший согласие |
| Предоставление доступа | Администрация университета выпускает токен | Администрация университета регистрирует приложение, студент разрешает доступ на экране согласия |
Значение заголовка Authorization | Токен вида qos_… | Токен доступа Keycloak (JWT) |
| Объём сведений | Сведения модулей, указанных в токене | Сведения, доступные самому студенту, в пределах предоставленных модулей |
| Срок действия | Устанавливается при выпуске токена | Токен доступа — 1 час, сеанс — до 30 дней |
| Отзыв доступа | Администрация университета | Студент в кабинете либо администрация университета |
3.1. Выбор способа
- Токен API применяется для интеграции информационных систем: получения справочных сведений, расписания, каталога дисциплин, а также для обращения к моделям Alem от имени организации.
- «Войти через QAIRU» применяется, когда внешняя платформа работает со сведениями конкретного студента: его расписанием, заданиями, оценками, проектами.
Способ авторизации определяется по значению заголовка Authorization: Bearer: значение, начинающееся с qos_, рассматривается как токен API, любое иное — как токен доступа Keycloak. Заголовок x-api-key принимает только токен API.
Оба способа предназначены для серверных приложений. Токен API, секрет клиента и токены студента не размещаются в коде, исполняемом в браузере или в мобильном приложении, а также в общедоступных репозиториях.