База данных

API справка

Ниже перечислены основные REST‑эндпоинты этого сервиса. По умолчанию базовый URL: http(s)://data.mnu.kz/api. Для доступа к защищённым методам в заголовке X-API-Key передаётся ключ вида mnu-….

Авторизация

• GET /api/auth-required — возвращает { required: boolean }, нужно ли передавать API‑ключ.

Общие

• GET /api/info — информация по таблице студентов: есть ли данные, колонки, количество, имя последнего XLSX.
• GET /api/logs?lines=N — последние N строк логов (по умолчанию 2000).

Студенты

• GET /api/students?limit=&offset=&search=&column= — список студентов с пагинацией и поиском.
• GET /api/students/:id — студент по идентификатору.
• GET /api/students/inns — уникальные ИИН/ИНН студентов.
• GET /api/students/distinct?column=school — уникальные значения одной колонки.
• GET /api/students/distinct?columns=school,program — уникальные значения нескольких колонок.
• GET /api/students/select?columns=id,fullName&limit=&offset= — выборка по указанным полям.
• POST /api/import — импорт из XLSX в БД. Тело: { path?: string | null }.
• POST /api/clear — полностью очистить таблицу студентов.
• POST /api/download-latest — инициировать скачивание отчёта из Platonus и автоимпорт.

Сотрудники

• GET /api/staff?limit=&offset=&search=&column= — список сотрудников.
• GET /api/staff/:id — сотрудник по идентификатору.
• GET /api/staff/inns — уникальные ИИН сотрудников.
• GET /api/staff/distinct?column=department — уникальные значения поддерживаемых полей.
• GET /api/staff/select?columns=department,position — выборка по полям сотрудников.
• POST /api/staff-sync — синхронизация сотрудников с внешней системой (docflow).
• POST /api/staff-clear — очистить таблицу сотрудников.

API‑ключи

• GET /api/keys — список ключей (префикс, включён/выключен, дата создания).
• POST /api/keys — создать новый ключ. В ответе ключ показывается один раз.
• PATCH /api/keys/:id — включить/выключить ключ: тело { enabled: true | false }.
• DELETE /api/keys/:id — удалить ключ.

Пример запроса с ключом

curl -X GET "https://data.mnu.kz/api/students?limit=50&offset=0" \
  -H "X-API-Key: mnu-ВАШ_КЛЮЧ"