+7 (499) 113-14-13
+7 (499) 113-14-13
+7 (499) 113-14-13
?>

API & Webhook

В этом разделе вы узнаете, как использовать открытое API нашей ЛМС-платформы «Импульс» и какие возможности интеграции с внешними сервисами доступны.

Аутентификация (Basic Auth)

Для обеспечения безопасности доступ к API может быть защищён через Basic Auth. В «настройках платформы» – «Общие настройки» добавлен чекбокс: «Включить настройки внешнего апи». Активируйте его и сгенерируйте два поля:

  • Логин API

  • Пароль API

Если включён соответствующий чекбокс, то все API-запросы должны быть выполнены с авторизацией. Пример использования в Postman:

«GET https://backend.lk-yvcht.ru/v1/external/class-folders»

Вкладка Authorization:
Type: Basic Auth

Username: user_xxx
Password: pass_xxx

Webhooks (вебхуки)

С помощью вебхуков вы можете получать уведомления о событиях в платформе. В настройках добавлены поля для указания ваших callback URL (См. скриншот выше):

  • user.created — вызывается при создании нового пользователя

  • user.course.assigned — вызывается при назначении курса учащемуся

 

Формат отправляемых данных (JSON):

Пример user.created:

{
"event": "user.created",
"timestamp": "2025-10-04T04:46:14+00:00",
"user": {
"id": 4939,
"name": "test",
"email": "test@site.com"
}
}

Пример user.course.assigned:

{
"event": "user.course.assigned",
"timestamp": "2025-10-04T04:51:47+00:00",
"user": {
"id": 4939,
"name": "test",
"email": "test@site.com"
},
"course": {
"id": 22,
"title": "Free access",
"start_date": "2025-10-04",
"end_date": null
}
}

🧪 Тестирование с Webhook.site

Для проверки вебхуков можно использовать Webhook.site:

  1. Перейдите на сайт, и он сгенерирует уникальный URL.

  2. Укажите этот URL в настройках вашей платформы в качестве callback.

  3. Совершите событие (создание пользователя или выдача курса).

  4. Убедитесь, что на Webhook.site прилетело уведомление.

Открытое API (Swagger) 

На главной странице личного кабинета администратора доступен переход к полному списку API-эндпоинтов платформы. Этот раздел открывает возможности для настройки гибких и кастомных интеграций с внешними системами — от простых подключений до сложных автоматизированных процессов.

Интеграции с Тильда

Общие настройки

Зайдя в «Настройки платформы», в раздел «Интеграции» можно увидеть раскрывающийся пункт: «Интеграция с Tilda»

Для подключения интеграции для начала необходимо включить чекбокс: «Включить интеграцию с Tilda»

Поля API name и API key необходимо оставить пустыми.

На сегодняшний день есть три готовые интеграции:

  1. Передача лидов из Тильда в СРМ-Импульс

  2. Создание учащегося и родителя с добавлением курсов или классов

  3. Добавление педагогов с конкретными курсами на платформу

Чтобы их подключить необходимо зайти в личный кабинет Tilda, зайти в настройки своего сайта – формы и создать Вебхук.
В поле WEBHOOK URL – вставить нужный вебхук из раздела «Интеграции с Tilda» на платформе Импульс, а также выбрать API Method – Header , поля API name и API key оставить пустыми и нажать сохранить.

После чего данный вебхук можно подключать к выбранным формам на тильде, однако в каждой форме необходимо верно передавать параметры, которые будут заполнять пользователи на Вашем сайте. Подробнее об этих параметрах распишем ниже для каждой из интеграций.

Передача параметра X-Space из Tilda в Impulse LMS

Для того чтобы система понимала, к какой школе относится заявка, в форму на Tilda нужно добавить скрытое поле с уникальным идентификатором вашего пространства (X-Space).

  1. Определите ваш X-Space

Ваш ID — это первая часть адреса вашей школы до домена .impulse-lms.com.

  • Если адрес https://school.impulse-lms.com → значение: school

Важно: Передавайте только короткий код. Не указывайте https://, точки или полный URL.

  1. Настройка вебхука в Tilda
  1. Зайдите в редактирование блока с формой.
  2. Перейдите в раздел «Настройки сайта» → «Сервисы приема данных из форм».
  3. Создайте Webhook и заполните поля как на скриншоте.
  4. Сохраните изменения и опубликуйте страницу.

Если параметр отображается корректно — настройка завершена.

 

Готовые интеграции* 

Текст будет дописан позже

На платформе реализована интеграция с SMS-центром, которая позволяет подтверждать номер телефона пользователей. При использовании этой интеграции все пользователи должны регистрироваться по номеру телефона. Важно учитывать, что в этом режиме в SMS-уведомлениях не будут отправляться логин и пароль.

При подтверждении номера временным паролем выступает код, который пользователь получает в SMS или в Telegram — в зависимости от выбранного способа.

Таким образом:

  • логин — подтверждённый номер телефона;

  • пароль — одноразовый код подтверждения.

На текущий момент на платформе не реализована отправка приветственных сообщений с логином и паролем в Telegram или SMS.

Ваша платформа успешно создана!