Skip to content

API-довідка

Усі ендпоінти знаходяться під /api.

Якщо не вказано інше, ендпоінти вимагають аутентифікації Sanctum.

Аутентифікація

MethodEndpointAccessDescription
POST/loginПублічнийАвтентифікувати користувача і повернути payload токена
POST/logoutАвторизованийВідкликати поточний токен

Запрошення

MethodEndpointAccessDescription
GET/invites/{token}ПублічнийОтримати метадані токена запрошення
POST/invites/acceptПублічнийСтворити акаунт за токеном запрошення
GET/invitesАдмінСписок запрошень в очікуванні
POST/invitesАдмінСтворити запрошення
POST/invites/{id}/resendАдмінОновити та повторно надіслати запрошення
DELETE/invites/{id}АдмінВідкликати запрошення в очікуванні

Курси

MethodEndpointAccessDescription
GET/coursesАвторизованийСписок курсів, видимих для ролі користувача
POST/coursesАдмінСтворити курс
GET/courses/{id}АвторизованийОтримати деталі курсу
PUT/courses/{id}АдмінОновити курс
DELETE/courses/{id}АдмінВидалити курс

Уроки та прогрес

MethodEndpointAccessDescription
GET/courses/{id}/lessonsАвторизованийУроки за курсом
POST/lessonsАдмінСтворити урок
PUT/lessons/reorderАдмінПеревпорядкувати уроки
PUT/lessons/{id}АдмінОновити урок
DELETE/lessons/{id}АдмінВидалити урок
POST/lessons/{id}/completeСпівробітникПозначити урок як завершений
GET/courses/{id}/progressАвторизованийОтримати ID завершених уроків користувача

Квізи та питання

MethodEndpointAccessDescription
GET/courses/{courseId}/quizzesАвторизованийКвізи за курсом
POST/quizzesАдмінСтворити квіз
PUT/quizzes/reorderАдмінПеревпорядкувати квізи
GET/quizzes/{id}АвторизованийОтримати квіз
PUT/quizzes/{id}АдмінОновити квіз
DELETE/quizzes/{id}АдмінВидалити квіз
GET/quizzes/{id}/questionsАвторизованийОтримати питання квізу
POST/quizzes/{id}/submitСпівробітникНадіслати квіз і отримати бал
POST/questionsАдмінСтворити питання
PUT/questions/reorderАдмінПеревпорядкувати питання
PUT/questions/{id}АдмінОновити питання
DELETE/questions/{id}АдмінВидалити питання

Результати

MethodEndpointAccessDescription
GET/results/{userId}АвторизованийОтримати результати користувача
DELETE/results/{userId}/resetАвторизованийСкинути прогрес користувача

Користувачі та аналітика для адміну

MethodEndpointAccessDescription
GET/usersАдмінСписок користувачів
PUT/users/{id}/roleАдмінЗмінити роль користувача
DELETE/users/{id}АдмінВидалити користувача
GET/admin/statsАдмінПідсумок статистики платформи
GET/admin/team-progressАдмінАгреговані дані прогресу команди

Призначення

MethodEndpointAccessDescription
GET/assignmentsАдмінСписок призначень
POST/assignmentsАдмінСтворити призначення
PUT/assignments/{id}АдмінОновити призначення
DELETE/assignments/{id}АдмінВидалити призначення

Примітки

  • Авторизація для співробітників і адміністраторів забезпечується логікою на рівні контролерів.
  • Опис маршрутів зберігається в backend routes/api.php.
  • Поріг проходження, який використовує логіка завершення квізу, становить 80%.