Поиск

Ниже — все страницы документации. Поле поиска в шапке фильтрует этот список; без JavaScript он остаётся полным перечнем, то есть картой сайта.

Начало #

• Начало — Что это за платформа, как она устроена, чем отличается от GetCourse и School-master, как поставить на сервер и что сделать в первые полчаса.
• Что это за платформа — Коробочная LMS для онлайн-школы: код и база на вашем сервере, одна установка — одна школа, разовая покупка вместо подписки.
• Как устроена — Модульный монолит из трёх процессов, шина событий вместо прямых вызовов, адаптеры к внешним сервисам и требования к серверу.
• Чем отличается — Сравнение с GetCourse и School-master по четырём вещам, где разница принципиальна, и честный список того, чего у нас нет.
• Установка — Требования к серверу, предустановочный чек-лист из шести проверок, порядок установки и честное состояние сценария обновления.
• Первый запуск — Что сделать в первые полчаса после установки: настройки школы, первый курс с уроком и видео, ученик, доступ, проверка входа.

Как пользоваться #

• Как пользоваться — Работа со школой по задачам, а не по кнопкам: курсы и уроки, доступы, ученики, продажи, рассылки, сценарии.
• Курсы и уроки — Три уровня — курс, модуль, урок. Блоки урока, видео двумя источниками, задания и ответы, тесты, публикация.
• Доступы — Доступ как запись, четыре правила открытия урока, дата старта, условия только через «и», продление, заморозка, отзыв и ответ на «почему урок закрыт».
• Ученики — Поиск, профиль, теги, группы, перенос между потоками, объединение и удаление данных.
• Продажи — Продаж в продукте ещё нет: ни продуктов, ни тарифов, ни заказов, ни приёма платежей. Что спроектировано и где это прочитать.
• Рассылки — Рассылок в продукте ещё нет. Что уже решено про согласия, отписки и транспорты — и почему эти правила важнее самой отправки.
• Сценарии — Сценариев в продукте ещё нет. Что спроектировано: узлы графа, исполнение на очередях, счётчики и трассировка конкретного человека.

Проект API #

• Проект API — ПРОЕКТНАЯ СПЕЦИФИКАЦИЯ, А НЕ РАБОТАЮЩЕЕ API. Реализации ещё нет, часть адресов предположительна. Оценить возможности можно, писать интеграцию — нет.
• Аутентификация — Токен в заголовке Authorization, префиксы live и test, действие от лица пользователя, ссылка автовхода.
• Ключи — Школа заводит ключи сама: создание, права, срок, список адресов, отзыв.
• Права — У ключа нет своего языка прав: ключ — такой же субъект, как человек, и проверяет его та же функция.
• Формат — Адрес, транспорт, тело, именование, идентификаторы, даты, деньги, конверт ответа.
• Пагинация, фильтры, сортировка — Курсорная пагинация, единый синтаксис фильтров, фильтр по сегменту, разворачивание связей, выбор полей.
• Лимиты — Лимиты защищают ваш сервер, а не ограничивают вас: значения, заголовки, поведение при превышении.
• Ошибки — Что вернётся, если прав не хватило, объект удалён, превышен лимит или тело не прошло проверку. Форма ошибки и полный список кодов.
• Идемпотентность — Ключ идемпотентности на запись, повтор с тем же ключом, тот же ключ с другим телом.
• Каталог ресурсов — Все 226 операций API по разделам, с путями, параметрами и готовым curl. Собрано из OpenAPI.
• Вебхуки — Подписка на события, единый формат конверта, подпись HMAC, ретраи, переигрывание пропущенного.
• Каталог событий — Все 82 событий системы по группам. Одно и то же событие приходит в вебхук, запускает сценарий и лежит в журнале.
• Песочница — Тестовый ключ против той же установки: платежи в тестовом режиме, сообщения не уходят наружу.
• Аналитика — Операции API раздела «Аналитика»: 5 шт. Пути, параметры, коды ответа и готовый curl.
• CRM, сегменты, сообщения — Операции API раздела «CRM, сегменты, сообщения»: 25 шт. Пути, параметры, коды ответа и готовый curl.
• Коммерция — Операции API раздела «Коммерция»: 45 шт. Пути, параметры, коды ответа и готовый curl.
• Обучение — Операции API раздела «Обучение»: 57 шт. Пути, параметры, коды ответа и готовый curl.
• Пользователи и доступ — Операции API раздела «Пользователи и доступ»: 31 шт. Пути, параметры, коды ответа и готовый curl.
• Сайт и файлы — Операции API раздела «Сайт и файлы»: 17 шт. Пути, параметры, коды ответа и готовый curl.
• Сценарии (автоматизации) — Операции API раздела «Сценарии (автоматизации)»: 12 шт. Пути, параметры, коды ответа и готовый curl.
• Служебное — Операции API раздела «Служебное»: 19 шт. Пути, параметры, коды ответа и готовый curl.
• Вебинары — Операции API раздела «Вебинары»: 15 шт. Пути, параметры, коды ответа и готовый curl.

Оформление #

• Оформление — Как менять вид школы, не трогая нашу вёрстку: переменные, якоря, темы, блоки кода, аварийный выключатель.
• Переменные оформления — 84 публичных переменных CSS, которыми школа меняет цвета, шрифты, скругления и плотность интерфейса, не трогая нашу вёрстку.
• Якоря — Якорей в продукте пока нет ни одного. Что это такое, почему нельзя вместо них задокументировать классы вёрстки и когда они появятся.
• Темы школы — Куда писать свой CSS, как посмотреть до применения, как откатить — и аварийный выключатель, который понадобится раньше, чем кажется.
• Блоки кода — Блоков кода в конструкторе ещё нет. Что решено: три блока разной опасности, изоляция CSS документом, JS никогда не выполняется в админке.
• Аварийный выключатель — Что делать, если тема сломала интерфейс: адрес без темы, экраны, к которым тема не применяется никогда, и предупреждение до сохранения.

Рецепты #

• Рецепты — Не «вот метод», а «вот как сделать задачу целиком»: от внешнего лендинга до своего отчёта по доходимости.
• Выдать доступ после оплаты на внешнем лендинге — Лендинг на Tilda принимает оплату, школа выдаёт доступ: заказ, платёж, покупка, проверка.
• Синхронизировать с CRM — Двусторонняя связь со сторонней CRM на вебхуках: что слать, что принимать, как не задвоить.
• Перекрасить школу под фирменный стиль — Одна строка задаёт весь цвет школы, включая тёмную тему. Плюс шрифт, скругления и плотность — и что проверить, чтобы не сломать читаемость.
• Убрать колонку из таблицы заказов — Задача на конкретный элемент, а не на цвет вообще: как это делается якорем.
• Построить свой отчёт по доходимости — Выгрузить прогресс по урокам и собрать свой отчёт во внешнем инструменте.

Для агентов #

• Для агентов — Как работать со школой из ИИ-агента: машинные выходы документации, MCP-сервер, ключ с узкими правами.
• Машинные выходы — llms.txt, llms-full.txt, openapi.draft.json и Markdown-исходник любой страницы — что это, где лежит и чем отличается одно от другого.
• MCP-сервер: как подключить — Сервер MCP отдаёт операции API как инструменты. Одна настройка в агенте.
• Что умеет MCP-сервер — Перечень инструментов и то, как он соотносится с операциями API.
• Ключ с узкими правами — Ключ для агента по умолчанию создаётся только на чтение. Права на запись выдаются явно, и на экране создания об этом написано словами.

Обновления #

• Обновления — Что изменилось в каждой версии, что появилось и чего пока нет. Читателю коробки этот раздел нужен, чтобы решить, стоит ли обновляться.