AC Academia API Academia Code

OpenAPI 3.1.0

Документація API

Єдина точка входу для мобільного застосунку Academia Code. Авторизація — Bearer-токен, отриманий через /api/v1/auth/login (aud=platform).

Завантажити JSON Огляд

Авторизація

Отримайте токен: POST /api/v1/auth/login з тілом {"username": "...", "password": "..."}. Далі передавайте Authorization: Bearer <access_token>. Токен має aud=platform і працює для всіх сервісів.

curl -s https://api.codeacademy.com.ua/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username":"owner","password":"..."}'

Помилки повертаються у форматі Problem Details: title, status, detail.

Авторизація

3
МетодШляхОписДоступПараметри
POST /api/v1/auth/login Вхід для мобільного застосунку публічний —
POST /api/v1/auth/refresh Оновити access-токен публічний —
GET /api/v1/me Поточний користувач і доступні сервіси Bearer —

CRM

4
МетодШляхОписДоступПараметри
GET /api/v1/crm/clients Клієнти (діти) та їхні групи Bearer —
GET /api/v1/crm/clients/{child_id} Профіль дитини Bearer child_id
GET /api/v1/crm/groups Групи та викладачі Bearer —
GET /api/v1/crm/schedule Розклад групи Bearer —

Фінанси

5
МетодШляхОписДоступПараметри
GET /api/v1/finance/balance Баланс дитини Bearer —
GET /api/v1/finance/ledger Операції по дитині Bearer —
GET /api/v1/finance/tokens Токени оплати Bearer —
GET /api/v1/finance/debtors Боржники (менеджер) Bearer —
GET /api/v1/finance/access/{child_id} Стан доступу до уроків Bearer child_id

Навчання

5
МетодШляхОписДоступПараметри
GET /api/v1/learning/courses Курси учня Bearer —
GET /api/v1/learning/courses/{course_id} Курс із прогресом Bearer course_id
GET /api/v1/learning/progress Прогрес за уроками Bearer —
GET /api/v1/learning/submissions Здані завдання Bearer —
GET /api/v1/learning/achievements Досягнення Bearer —

Викладач

5
МетодШляхОписДоступПараметри
GET /api/v1/teacher/schedule Розклад викладача Bearer —
GET /api/v1/teacher/lessons/{lesson_id} Урок, відвідуваність, звіт Bearer lesson_id
GET /api/v1/teacher/reports Звіти про уроки Bearer —
GET /api/v1/teacher/availability Доступність викладача Bearer —
GET /api/v1/teacher/students Учні викладача Bearer —

Батьки

5
МетодШляхОписДоступПараметри
GET /api/v1/parent/children Діти батьківського акаунта Bearer —
GET /api/v1/parent/balance Баланс і стан оплати Bearer —
GET /api/v1/parent/schedule Розклад дітей Bearer —
GET /api/v1/parent/progress Прогрес дітей Bearer —
GET /api/v1/parent/reports Звіти викладачів Bearer —

Автор

2
МетодШляхОписДоступПараметри
GET /api/v1/author/courses Опубліковані курси Bearer —
GET /api/v1/author/courses/{course_id} Структура курсу Bearer course_id

Ігри

4
МетодШляхОписДоступПараметри
GET /api/v1/games Ігри користувача Bearer —
POST /api/v1/games/join Приєднатися до кімнати за кодом Bearer —
GET /api/v1/games/{game_id}/state Поточний стан кімнати Bearer game_id
POST /api/v1/games/{game_id}/answer Відповідь на питання Bearer game_id

Схеми даних

LoginRequest

  • usernamestring
  • passwordstring
  • servicestring

TokenPair

  • access_tokenstring
  • refresh_tokenstring
  • token_typestring
  • expires_ininteger

GameAnswer

  • choiceinteger

GameJoin

  • codestring
  • nicknamestring