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Операциялар құрамы ақпараттық жүйенің дамуына қарай кеңейтіледі. Интеграцияны өзгертер алдында спецификацияны қайта сұрату ұсынылады.