Программный интерфейс QAIRU OS API (далее — API) предоставляет внешним информационным системам доступ к сведениям информационной системы Qazaq AI Research University в режиме чтения и к моделям платформы Alem.Cloud.
Настоящее руководство устанавливает порядок получения доступа к API, способы авторизации, состав модулей, форматы запросов и ответов, порядок хранения и обработки запросов, а также действующие ограничения.
В настоящем руководстве используются следующие понятия:
- токен API — секретный ключ доступа, выпускаемый администрацией университета для внешней информационной системы; определяет перечень доступных модулей и действующие ограничения;
- приложение — внешняя платформа, зарегистрированная администрацией университета для входа студентов через учётную запись QAIRU («Войти через QAIRU»);
- токен доступа — токен, выдаваемый приложению от имени студента по протоколу OAuth 2.0 после его согласия;
- модуль — раздел информационной системы, доступ к которому предоставляется токеном;
- модуль данных — модуль, предоставляющий сведения информационной системы только для чтения;
- модуль ALEM — модуль, предоставляющий доступ к языковым моделям, моделям эмбеддингов, ранжирования и распознавания речи платформы Alem.Cloud.
1.1. Базовый адрес
Запросы к API направляются по протоколу HTTPS. Адрес запроса образуется из базового адреса и пути операции:
https://api.bbx.kz/os/v1В руководстве пути операций приводятся относительно домена API, например /os/v1/me. Запросы и ответы передаются в кодировке UTF-8.
Запросы к API и ответы на них сохраняются и обрабатываются в порядке, изложенном в разделе «Хранение и обработка запросов».