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-ге жіберілген сұраулар мен оларға берілген жауаптар «Сұрауларды сақтау және өңдеу» бөлімінде баяндалған тәртіппен сақталады және өңделеді.