Токен API предоставляет доступ только к модулям, указанным при его выпуске; токен доступа студента — к модулям, области доступа которых предоставлены. Каждому модулю соответствует один или несколько префиксов пути вида /os/v1/{префикс}.
| КОД | ПРЕФИКСЫ ПУТИ | ОБЛАСТЬ ДОСТУПА OAUTH | НАЗНАЧЕНИЕ |
|---|---|---|---|
ALEM | /os/v1/alem | qairu.alem.read | Языковые модели, эмбеддинги, ранжирование и распознавание речи платформы Alem.Cloud |
USERS | /os/v1/users/os/v1/roles | qairu.users.read | Учётные записи и роли пользователей |
FILES | /os/v1/files | qairu.files.read | Файлы информационной системы |
LEARNING | /os/v1/learning/os/v1/competency | qairu.learning.read | Обучение: дисциплины, задания, оценки и компетенции |
ACADEMIC | /os/v1/academic | qairu.academic.read | Образовательные программы, учебные планы и каталог дисциплин |
SCHEDULING | /os/v1/scheduling | qairu.scheduling.read | Расписание занятий |
SKILLMATCH | /os/v1/skillmatch | qairu.skillmatch.read | Сопоставление навыков и профессиональных требований |
CLUBS | /os/v1/clubs | qairu.clubs.read | Студенческие клубы и их мероприятия |
PROJECTS | /os/v1/projects | qairu.projects.read | Студенческие и исследовательские проекты |
IDEAS | /os/v1/ideas/os/v1/complaints | qairu.ideas.read | Идеи и обращения студентов |
Модули данных предоставляют сведения информационной системы только для чтения. Допускаются исключительно запросы методом GET; запрос другим методом отклоняется с кодом 405 method_not_allowed и заголовком Allow: GET.
Путь запроса повторяет путь соответствующего раздела информационной системы: операция, доступная в системе по пути /api/{раздел}/…, вызывается по пути /os/v1/{раздел}/…. Параметры строки запроса передаются без изменений.
curl https://api.bbx.kz/os/v1/academic/catalog/disciplines \
-H "Authorization: Bearer qos_YOUR_TOKEN"Ответ передаётся в том виде, в каком его формирует информационная система: код состояния, тело ответа и заголовки Content-Type, Content-Disposition и Location сохраняются.
Запрос к модулю, не указанному в токене API, отклоняется с кодом module_not_allowed, к модулю без предоставленной области доступа — с кодом scope_not_granted. Модуль может быть временно отключён администрацией университета; в этом случае возвращается код module_disabled.
6.1. Спецификация операций
Полный перечень операций с параметрами, схемами ответов и примерами приведён в справочнике API.
Перечень операций, доступных конкретному токену API, возвращает запрос GET /os/v1/openapi.json. Ответ представляет собой документ в формате OpenAPI 3 и включает только модули, указанные в токене.
curl https://api.bbx.kz/os/v1/openapi.json \
-H "Authorization: Bearer qos_YOUR_TOKEN" \
-o qairu-os-openapi.jsonСостав операций расширяется по мере развития информационной системы. Перед изменением интеграции рекомендуется запрашивать спецификацию повторно.