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

Схема связей

Сущности

Владелец бизнеса в Exode: репетитор, школа, продюсер или университет. У продавца есть баланс, реквизиты и школа — одна на продавца. SaaS API работает только с продавцами, у которых есть школа. Запросы к API всегда выполняются в контексте продавца (заголовок Seller-Id — его числовой ID, см. «Как получить токен и идентификаторы»). См. seller.
Образовательная площадка продавца со своим доменом, пользователями, курсами и настройками. Контекст школы задаётся заголовком School-Id; он должен совпадать со школой продавца из Seller-Id. См. school.Сегмент школы (segment) определяет доступные возможности: Commerce — коммерческая онлайн-школа (продажи, счета, платежи), Corporate — корпоративное обучение сотрудников (только в таких школах работают методы оргструктуры staff/*).
Учётная запись в школе (студент, куратор, родитель, а также сервисные пользователи-интеграции). Поле extId связывает пользователя с записью в вашей CRM/LMS: это ваш собственный идентификатор — строка до 50 символов без / и пробелов, уникальная в пределах школы. См. user.
Технический пользователь школы, от имени которого работает интеграция. Создаётся вместе с API-ключом на странице Управление → Школа → Для разработчиков → API-ключи; его токен передаётся в Authorization, а набор прав настраивается галочками на странице ключа (см. «Права доступа»).
Группа объединяет пользователей вокруг курса/продукта и задаёт правила доступа и расписание. GroupMember — связь пользователя с группой. См. group.
Продаваемая единица: курс, доступ к школе или цифровой товар. У продукта есть цены (productPrice) и скидки (discount). См. product.
Учебный курс продукта: уроки (courseLesson), практики (courseLessonPractice), попытки и прогресс (courseProgress) каждого студента. См. course.
Факт доступа пользователя к продукту: активность, дата истечения, биллинг (подписка/рассрочка). Именно доступ открывает студенту курс. См. product.
Счёт фиксирует покупку продуктов пользователем; платёж — факт оплаты счёта через эквайринг. См. payment.
Макеты форм продавца (анкеты, кастомные поля при регистрации) и значения полей, заполненные пользователями. См. form.

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

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

Обновлено: 2026-09-25 13:43 UTC