Skip to main content
Перед интеграцией полезно понимать, как устроена модель данных Exode и как сущности связаны между собой.

Схема связей

Сущности

Продавец (Seller)
Владелец бизнеса в Exode: репетитор, школа, продюсер или университет. У продавца есть баланс, реквизиты и одна или несколько школ. Запросы к API всегда выполняются в контексте продавца (заголовок Seller-Id).
Школа (School)
Образовательная площадка продавца со своим доменом, пользователями, курсами и настройками. Контекст школы задаётся заголовком School-Id. См. school.
Пользователь (User)
Учётная запись в школе (студент, куратор, родитель, а также сервисные пользователи-интеграции). Поле extId связывает пользователя с записью в вашей CRM/LMS. См. user.
Группа (Group) и участник (GroupMember)
Группа объединяет пользователей вокруг курса/продукта и задаёт правила доступа и расписание. GroupMember — связь пользователя с группой. См. group.
Продукт (Product)
Продаваемая единица: курс, доступ к школе или цифровой товар. У продукта есть цены (productPrice) и скидки (discount). См. product.
Курс (Course) и обучение
Учебный курс продукта: уроки (courseLesson), практики (courseLessonPractice), попытки и прогресс (courseProgress) каждого студента. См. course.
Доступ (ProductAccess)
Факт доступа пользователя к продукту: активность, дата истечения, биллинг (подписка/рассрочка). Именно доступ открывает студенту курс. См. product.
Счёт (Invoice) и платёж (Payment)
Счёт фиксирует покупку продуктов пользователем; платёж — факт оплаты счёта через эквайринг. См. payment.
Формы (FormLayout) и поля (FormFieldValue)
Макеты форм продавца (анкеты, кастомные поля при регистрации) и значения полей, заполненные пользователями. См. form.

Как это связано с API

  • Каждый запрос идёт в контексте продавца (Seller-Id) и школы (School-Id).
  • Сущности из ответов методов соответствуют справочнику объектов.
  • Изменения этих сущностей (регистрация, оплата, прогресс, выдача доступа) можно получать через вебхуки.
Готовы к первому запросу? Перейдите к быстрому старту.