# Документация LMS

> Коробочная LMS-платформа для онлайн-школ: одна установка — одна школа. Документация к версии продукта 0.1.0. Продукт в разработке, и это видно по пометкам: «страница ещё не написана» — значит продукт умеет, а мы не описали; «этого ещё нет в продукте» — значит не умеет. Раздел «Проект API» описывает замысел, а не работающее API: реализации пока нет.

Вся документация одним текстом — /llms-full.txt.
Спецификация API — /openapi.draft.json. В имени «draft» не для красоты: API ещё не написано,
спецификация собрана из проектного документа, часть адресов выведена из сокращений и может измениться.
Адрес /openapi.json не занят намеренно — он появится, когда появится API.
Любая страница доступна в Markdown: к её адресу добавляется `.md`.

## Начало

Что это за платформа, как она устроена, чем отличается от GetCourse и School-master, как поставить и запустить.

- [Начало](https://docs-school.sersidteh.ru/start/): Что это за платформа, как она устроена, чем отличается от GetCourse и School-master, как поставить на сервер и что сделать в первые полчаса.
- [Что это за платформа](https://docs-school.sersidteh.ru/start/what-is-it/): Коробочная LMS для онлайн-школы: код и база на вашем сервере, одна установка — одна школа, разовая покупка вместо подписки.
- [Как устроена](https://docs-school.sersidteh.ru/start/architecture/): Модульный монолит из трёх процессов, шина событий вместо прямых вызовов, адаптеры к внешним сервисам и требования к серверу.
- [Чем отличается](https://docs-school.sersidteh.ru/start/differences/): Сравнение с GetCourse и School-master по четырём вещам, где разница принципиальна, и честный список того, чего у нас нет.
- [Установка](https://docs-school.sersidteh.ru/start/install/): Требования к серверу, предустановочный чек-лист из шести проверок, порядок установки и честное состояние сценария обновления. [написано наполовину]
- [Первый запуск](https://docs-school.sersidteh.ru/start/first-run/): Что сделать в первые полчаса после установки: настройки школы, первый курс с уроком и видео, ученик, доступ, проверка входа.

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

Работа со школой по задачам: курсы и уроки, доступы, ученики, продажи, рассылки, сценарии.

- [Как пользоваться](https://docs-school.sersidteh.ru/guide/): Работа со школой по задачам, а не по кнопкам: курсы и уроки, доступы, ученики, продажи, рассылки, сценарии. [страница ещё не написана]
- [Курсы и уроки](https://docs-school.sersidteh.ru/guide/courses/): Три уровня — курс, модуль, урок. Блоки урока, видео двумя источниками, задания и ответы, тесты, публикация.
- [Доступы](https://docs-school.sersidteh.ru/guide/access/): Доступ как запись, четыре правила открытия урока, дата старта, условия только через «и», продление, заморозка, отзыв и ответ на «почему урок закрыт».
- [Ученики](https://docs-school.sersidteh.ru/guide/students/): Поиск, профиль, теги, группы, перенос между потоками, объединение и удаление данных. [страница ещё не написана]
- [Продажи](https://docs-school.sersidteh.ru/guide/sales/): Продаж в продукте ещё нет: ни продуктов, ни тарифов, ни заказов, ни приёма платежей. Что спроектировано и где это прочитать. [этого ещё нет в продукте]
- [Рассылки](https://docs-school.sersidteh.ru/guide/messaging/): Рассылок в продукте ещё нет. Что уже решено про согласия, отписки и транспорты — и почему эти правила важнее самой отправки. [этого ещё нет в продукте]
- [Сценарии](https://docs-school.sersidteh.ru/guide/scenarios/): Сценариев в продукте ещё нет. Что спроектировано: узлы графа, исполнение на очередях, счётчики и трассировка конкретного человека. [этого ещё нет в продукте]

## Проект API

ПРОЕКТНАЯ СПЕЦИФИКАЦИЯ, А НЕ РАБОТАЮЩЕЕ API. Реализации пока нет: маршрутов /v1/* в продукте ноль, часть адресов выведена из сокращённой записи и может измениться. Писать интеграцию по этому разделу нельзя, оценить, закроет ли платформа задачу, — можно. Ключи, права, формат, пагинация, лимиты, ошибки, идемпотентность, каталог ресурсов, вебхуки, песочница.

- [Проект API](https://docs-school.sersidteh.ru/api/): ПРОЕКТНАЯ СПЕЦИФИКАЦИЯ, А НЕ РАБОТАЮЩЕЕ API. Реализации ещё нет, часть адресов предположительна. Оценить возможности можно, писать интеграцию — нет.
- [Аутентификация](https://docs-school.sersidteh.ru/api/auth/): Токен в заголовке Authorization, префиксы live и test, действие от лица пользователя, ссылка автовхода. [страница ещё не написана]
- [Ключи](https://docs-school.sersidteh.ru/api/keys/): Школа заводит ключи сама: создание, права, срок, список адресов, отзыв. [страница ещё не написана]
- [Права](https://docs-school.sersidteh.ru/api/permissions/): У ключа нет своего языка прав: ключ — такой же субъект, как человек, и проверяет его та же функция. [страница ещё не написана]
- [Формат](https://docs-school.sersidteh.ru/api/format/): Адрес, транспорт, тело, именование, идентификаторы, даты, деньги, конверт ответа. [страница ещё не написана]
- [Пагинация, фильтры, сортировка](https://docs-school.sersidteh.ru/api/pagination/): Курсорная пагинация, единый синтаксис фильтров, фильтр по сегменту, разворачивание связей, выбор полей. [страница ещё не написана]
- [Лимиты](https://docs-school.sersidteh.ru/api/limits/): Лимиты защищают ваш сервер, а не ограничивают вас: значения, заголовки, поведение при превышении. [страница ещё не написана]
- [Ошибки](https://docs-school.sersidteh.ru/api/errors/): Что вернётся, если прав не хватило, объект удалён, превышен лимит или тело не прошло проверку. Форма ошибки и полный список кодов. [страница ещё не написана]
- [Идемпотентность](https://docs-school.sersidteh.ru/api/idempotency/): Ключ идемпотентности на запись, повтор с тем же ключом, тот же ключ с другим телом. [страница ещё не написана]
- [Каталог ресурсов](https://docs-school.sersidteh.ru/api/reference/): Все 226 операций API по разделам, с путями, параметрами и готовым curl. Собрано из OpenAPI.
- [Вебхуки](https://docs-school.sersidteh.ru/api/webhooks/): Подписка на события, единый формат конверта, подпись HMAC, ретраи, переигрывание пропущенного. [страница ещё не написана]
- [Каталог событий](https://docs-school.sersidteh.ru/api/events/): Все 82 событий системы по группам. Одно и то же событие приходит в вебхук, запускает сценарий и лежит в журнале.
- [Песочница](https://docs-school.sersidteh.ru/api/sandbox/): Тестовый ключ против той же установки: платежи в тестовом режиме, сообщения не уходят наружу. [страница ещё не написана]
- [Аналитика](https://docs-school.sersidteh.ru/api/reference/analitika/): Операции API раздела «Аналитика»: 5 шт. Пути, параметры, коды ответа и готовый curl.
- [CRM, сегменты, сообщения](https://docs-school.sersidteh.ru/api/reference/crm-segmenty-soobshheniya/): Операции API раздела «CRM, сегменты, сообщения»: 25 шт. Пути, параметры, коды ответа и готовый curl.
- [Коммерция](https://docs-school.sersidteh.ru/api/reference/kommerciya/): Операции API раздела «Коммерция»: 45 шт. Пути, параметры, коды ответа и готовый curl.
- [Обучение](https://docs-school.sersidteh.ru/api/reference/obuchenie/): Операции API раздела «Обучение»: 57 шт. Пути, параметры, коды ответа и готовый curl.
- [Пользователи и доступ](https://docs-school.sersidteh.ru/api/reference/polzovateli-i-dostup/): Операции API раздела «Пользователи и доступ»: 31 шт. Пути, параметры, коды ответа и готовый curl.
- [Сайт и файлы](https://docs-school.sersidteh.ru/api/reference/sajt-i-fajly/): Операции API раздела «Сайт и файлы»: 17 шт. Пути, параметры, коды ответа и готовый curl.
- [Сценарии (автоматизации)](https://docs-school.sersidteh.ru/api/reference/scenarii-avtomatizacii/): Операции API раздела «Сценарии (автоматизации)»: 12 шт. Пути, параметры, коды ответа и готовый curl.
- [Служебное](https://docs-school.sersidteh.ru/api/reference/sluzhebnoe/): Операции API раздела «Служебное»: 19 шт. Пути, параметры, коды ответа и готовый curl.
- [Вебинары](https://docs-school.sersidteh.ru/api/reference/vebinary/): Операции API раздела «Вебинары»: 15 шт. Пути, параметры, коды ответа и готовый curl.

## Оформление

Как менять вид школы, не трогая нашу вёрстку: переменные оформления, якоря, темы, блоки кода, аварийный выключатель.

- [Оформление](https://docs-school.sersidteh.ru/appearance/): Как менять вид школы, не трогая нашу вёрстку: переменные, якоря, темы, блоки кода, аварийный выключатель. [страница ещё не написана]
- [Переменные оформления](https://docs-school.sersidteh.ru/appearance/variables/): 84 публичных переменных CSS, которыми школа меняет цвета, шрифты, скругления и плотность интерфейса, не трогая нашу вёрстку.
- [Якоря](https://docs-school.sersidteh.ru/appearance/anchors/): Якорей в продукте пока нет ни одного. Что это такое, почему нельзя вместо них задокументировать классы вёрстки и когда они появятся. [этого ещё нет в продукте]
- [Темы школы](https://docs-school.sersidteh.ru/appearance/themes/): Куда писать свой CSS, как посмотреть до применения, как откатить — и аварийный выключатель, который понадобится раньше, чем кажется.
- [Блоки кода](https://docs-school.sersidteh.ru/appearance/code-blocks/): Блоков кода в конструкторе ещё нет. Что решено: три блока разной опасности, изоляция CSS документом, JS никогда не выполняется в админке. [этого ещё нет в продукте]
- [Аварийный выключатель](https://docs-school.sersidteh.ru/appearance/kill-switch/): Что делать, если тема сломала интерфейс: адрес без темы, экраны, к которым тема не применяется никогда, и предупреждение до сохранения.

## Рецепты

Готовые решения целых задач: доступ после оплаты на внешнем лендинге, синхронизация с CRM, фирменный стиль, свой отчёт по доходимости.

- [Рецепты](https://docs-school.sersidteh.ru/recipes/): Не «вот метод», а «вот как сделать задачу целиком»: от внешнего лендинга до своего отчёта по доходимости. [страница ещё не написана]
- [Выдать доступ после оплаты на внешнем лендинге](https://docs-school.sersidteh.ru/recipes/access-after-external-payment/): Лендинг на Tilda принимает оплату, школа выдаёт доступ: заказ, платёж, покупка, проверка. [этого ещё нет в продукте]
- [Синхронизировать с CRM](https://docs-school.sersidteh.ru/recipes/crm-sync/): Двусторонняя связь со сторонней CRM на вебхуках: что слать, что принимать, как не задвоить. [этого ещё нет в продукте]
- [Перекрасить школу под фирменный стиль](https://docs-school.sersidteh.ru/recipes/brand-colors/): Одна строка задаёт весь цвет школы, включая тёмную тему. Плюс шрифт, скругления и плотность — и что проверить, чтобы не сломать читаемость.
- [Убрать колонку из таблицы заказов](https://docs-school.sersidteh.ru/recipes/hide-orders-column/): Задача на конкретный элемент, а не на цвет вообще: как это делается якорем. [этого ещё нет в продукте]
- [Построить свой отчёт по доходимости](https://docs-school.sersidteh.ru/recipes/completion-report/): Выгрузить прогресс по урокам и собрать свой отчёт во внешнем инструменте. [этого ещё нет в продукте]

## Для агентов

Как работать со школой из ИИ-агента: MCP-сервер, ключ с узкими правами, машинные выходы документации.

- [Для агентов](https://docs-school.sersidteh.ru/agents/): Как работать со школой из ИИ-агента: машинные выходы документации, MCP-сервер, ключ с узкими правами. [страница ещё не написана]
- [Машинные выходы](https://docs-school.sersidteh.ru/agents/machine-readable/): llms.txt, llms-full.txt, openapi.draft.json и Markdown-исходник любой страницы — что это, где лежит и чем отличается одно от другого.
- [MCP-сервер: как подключить](https://docs-school.sersidteh.ru/agents/mcp/): Сервер MCP отдаёт операции API как инструменты. Одна настройка в агенте. [этого ещё нет в продукте]
- [Что умеет MCP-сервер](https://docs-school.sersidteh.ru/agents/tools/): Перечень инструментов и то, как он соотносится с операциями API. [этого ещё нет в продукте]
- [Ключ с узкими правами](https://docs-school.sersidteh.ru/agents/keys/): Ключ для агента по умолчанию создаётся только на чтение. Права на запись выдаются явно, и на экране создания об этом написано словами. [написано наполовину]

## Обновления

Что изменилось в каждой версии, что сломалось и что с этим делать.

- [Обновления](https://docs-school.sersidteh.ru/changelog/): Что изменилось в каждой версии, что появилось и чего пока нет. Читателю коробки этот раздел нужен, чтобы решить, стоит ли обновляться. [написано наполовину]