API EduMentor
REST API мультитенантной платформы онлайн-обучения. Управляйте школами, курсами, учениками, тестами и прогрессом программно.
EduMentor — это SaaS-платформа, где каждая школа получает изолированное пространство на собственном субдомене {школа}.edumentor.kz. Этот справочник описывает HTTP API: аутентификацию, мультитенантность, формат ответов и полный перечень эндпоинтов по доменам.
Базовый адрес
Все запросы идут на https://api.edumentor.kz/api/v1. Школа определяется заголовком X-Tenant-Subdomain (или поддоменом в Host). Подробнее — в разделе Мультитенантность.С чего начать
Быстрый старт
Зарегистрируйте школу, получите токен и сделайте первый запрос за пару минут.
Аутентификация
JWT-токены, заголовок Authorization, время жизни и обновление.
Роли и доступы
Скоупы Public, Tenant, Curator, Student и Superadmin — кто что может вызывать.
Справочник API
Полный перечень эндпоинтов по доменам: курсы, тесты, экзамены, задания и др.
Ключевые принципы
- Единый формат ответа. Каждый ответ обёрнут в
{ success, data }или{ success, error }. См. Формат ответов. - Изоляция школ. Данные одной школы никогда не видны другой — каждый запрос привязан к тенанту. См. Мультитенантность.
- JWT-авторизация. Токен передаётся в заголовке
Authorization: Bearer <token>. См. Аутентификация. - Гранулярные права. Кураторы получают точечные разрешения (управление учениками, курсами, экзаменами). См. Роли и доступы.
Стабильность контракта
Эндпоинты /api/v1/auth/*, /api/v1/admin/* и /api/v1/t/* составляют публичный контракт. Несовместимые изменения сопровождаются новой версией пути.