An API token grants access only to the modules specified when it was issued; a student access token, to the modules whose scopes have been granted. Each module corresponds to one or more path prefixes of the form /os/v1/{prefix}.
| CODE | PATH PREFIXES | OAUTH SCOPE | PURPOSE |
|---|---|---|---|
ALEM | /os/v1/alem | qairu.alem.read | Language models, embeddings, reranking and speech recognition of the Alem.Cloud platform |
USERS | /os/v1/users/os/v1/roles | qairu.users.read | User accounts and roles |
FILES | /os/v1/files | qairu.files.read | Files of the information system |
LEARNING | /os/v1/learning/os/v1/competency | qairu.learning.read | Learning: courses, assignments, grades and competencies |
ACADEMIC | /os/v1/academic | qairu.academic.read | Educational programs, curricula and the course catalog |
SCHEDULING | /os/v1/scheduling | qairu.scheduling.read | Class schedule |
SKILLMATCH | /os/v1/skillmatch | qairu.skillmatch.read | Matching of skills and professional requirements |
CLUBS | /os/v1/clubs | qairu.clubs.read | Student clubs and their events |
PROJECTS | /os/v1/projects | qairu.projects.read | Student and research projects |
IDEAS | /os/v1/ideas/os/v1/complaints | qairu.ideas.read | Student ideas and complaints |
Data modules provide read-only access to the data of the information system. Only requests made with the GET method are permitted; a request made with another method is rejected with the code 405 method_not_allowed and the Allow: GET header.
The request path repeats the path of the corresponding part of the information system: an operation available in the system at /api/{section}/… is called at /os/v1/{section}/…. Query string parameters are passed unchanged.
curl https://api.bbx.kz/os/v1/academic/catalog/disciplines \
-H "Authorization: Bearer qos_YOUR_TOKEN"The response is passed in the form produced by the information system: the status code, the response body and the Content-Type, Content-Disposition and Location headers are preserved.
A request to a module not included in the API token is rejected with the code module_not_allowed; a request to a module whose scope has not been granted, with the code scope_not_granted. A module may be temporarily disabled by the university administration; in that case the code module_disabled is returned.
6.1. Operation specification
The full list of operations with parameters, response schemas and samples is given in the API reference.
The list of operations available to a specific API token is returned by the GET /os/v1/openapi.json request. The response is a document in the OpenAPI 3 format and includes only the modules specified in the token.
curl https://api.bbx.kz/os/v1/openapi.json \
-H "Authorization: Bearer qos_YOUR_TOKEN" \
-o qairu-os-openapi.jsonThe set of operations is extended as the information system develops. It is recommended to request the specification again before changing an integration.