Возможности API и интеграции

Обновлено 09.11.2026 · 6 минут чтения

Раздел «Интеграции» связывает школу с вашими системами без программиста: ключи REST API, вебхуки о заказах, оплатах и прогрессе учеников, готовые связки с amoCRM, Битрикс24 и 1С и журнал всех запросов.

Где найти и кому доступно

Меню слева → Интеграции. Раздел настраивают владелец школы и роли «Администратор» и «Технический специалист». Интеграции работают на всех платных тарифах платформы: на бесплатном тарифе в разделе будет предложение перейти на платный, а API ответит ошибкой 403 plan_required.

Кнопка Документация API открывает описание всех методов с примерами запросов и ответов - её можно передать разработчику.

Ключи API

Вкладка «Ключи API»: ключи школы, их права, ограничение по IP и состояние.
Вкладка «Ключи API»: ключи школы, их права, ограничение по IP и состояние.

Ключ принадлежит школе, а не сотруднику: увольнение сотрудника не ломает интеграцию. Ключ не даёт входа в панель. У школы может быть до 10 действующих ключей.

  1. Нажмите Создать ключ и введите название - например, «Сайт школы» или «1С».
  2. Укажите срок действия или оставьте поле пустым - ключ будет бессрочным. За 7 дней до окончания придёт письмо.
  3. Отметьте права. Кнопки Только чтение, Все права и Снять все выбирают их разом.
  4. При необходимости перечислите разрешённые IP-адреса или подсети - запрос с другого адреса получит ошибку 403.
  5. Нажмите Создать ключ и сразу скопируйте его.
Ключ показывается целиком один раз - сразу после создания.
Ключ показывается целиком один раз - сразу после создания.

Ключ показывается один раз

В базе хранится только хэш ключа, посмотреть его позже нельзя. Потеряли - нажмите Перевыпустить: старый ключ проработает ещё 24 часа, чтобы вы успели заменить его в своей системе. Отозвать отключает ключ сразу.

Права ключа:

ПравоЧто разрешает
users:read, users:writeпользователи: чтение; создание и изменение
courses:readкурсы: чтение
enrollments:read, enrollments:writeзаписи на курсы: чтение; выдача, продление и закрытие доступа
progress:readпрогресс и результаты учеников
orders:read, orders:writeзаказы и оплаты: чтение; создание заказа и отметка оплаты
groups:read, groups:writeгруппы: чтение; создание и участники
webhooks:manageуправление подписками на вебхуки

Как работает API

  • Адрес - https://umiweb.ru/api/v1, формат JSON, даты в ISO 8601 с часовым поясом школы. Школу API определяет по ключу.
  • Ключ передаётся в заголовке Authorization: Bearer uw_live_….
  • Лимит - 600 запросов в минуту на ключ и 3 000 на школу. Сверх лимита - ответ 429 с заголовком Retry-After.
  • Повтор POST-запроса с тем же заголовком Idempotency-Key в течение 24 часов вернёт первый ответ и не создаст дубль - например, второй заказ.
  • Каждый запрос записывается в журнал. Письмо приходит при создании ключа и при запросе с нового IP-адреса.

Что можно сделать через API: зарегистрировать ученика с сайта или из своей CRM, выдать или продлить доступ к курсу, создать заказ и отметить оплату, добавить ученика в группу, получить прогресс и результаты тестов для отчёта.

Вебхуки

Вкладка «Вебхуки»: адреса, события, состояние, подпись запроса и журнал доставок.
Вкладка «Вебхуки»: адреса, события, состояние, подпись запроса и журнал доставок.

Вебхук - это сообщение, которое платформа сама отправляет на ваш адрес, когда что-то произошло. Нажмите Добавить адрес, укажите адрес (только HTTPS; адреса внутренней сети и localhost запрещены), описание и события:

  • order.created - создан заказ (счёт); payment.succeeded - оплата прошла; payment.refunded - возврат оплаты;
  • user.created - зарегистрирован пользователь;
  • enrollment.created - выдан доступ к курсу; enrollment.expired - доступ закончился или закрыт;
  • progress.lesson_completed - урок пройден; test.finished - тест завершён; course.completed - курс пройден полностью;
  • document.issued - выдан документ об обучении.

Пройденных уроков бывает много, поэтому их можно получать каждым событием или сводкой раз в час (progress.lessons_summary).

Платформа отправляет POST с JSON. Ответ 2xx в течение 10 секунд - доставлено, иначе повторы через 1 минуту, 5 минут, 30 минут, 2, 6 и 24 часа. После 50 неудач подряд адрес ставится на паузу и приходит письмо. Доставка «хотя бы один раз»: одно событие может прийти дважды, сверяйте его id.

Каждый запрос подписан: заголовки X-UW-Timestamp и X-UW-Signature (HMAC-SHA256 с секретом адреса). Пример проверки - на вкладке. Секрет показывается один раз при создании адреса, кнопка Новый секрет выпускает новый. Кнопка Тест отправляет пробное событие. В журнале доставок видны событие, попытка, код ответа и ошибка, недоставленное можно Повторить.

amoCRM

  1. В amoCRM создайте внешнюю интеграцию: «Настройки» → «Интеграции» → «Создать интеграцию». Ссылка для перенаправления - адрес с вкладки amoCRM, доступ - «Доступ к данным аккаунта».
  2. Скопируйте ID интеграции и секретный ключ на вкладку и нажмите Сохранить, затем подтвердите доступ в amoCRM.
  3. Выберите воронку и этапы для новых заказов, оплат и возвратов, поля «Курс» и «Прогресс, %», этап выдачи доступа. Нажмите Проверить и Включить.

Что передаётся: новый заказ - контакт (без дублей по телефону и email) и сделка на этапе «Новый заказ»; оплата и возврат - смена этапа; выдача доступа, тест и окончание курса - примечания в сделке; прогресс - в поле сделки. Обратно: когда сделка переходит на этап выдачи доступа, заказ отмечается оплаченным, а если заказа нет - ученик из контакта получает доступ к курсу из поля «Курс». Токены обновляются сами.

Битрикс24

  1. В Битрикс24: «Разработчикам» → «Другое» → «Входящий вебхук» с правами «CRM (crm)». Скопируйте адрес вида https://портал.bitrix24.ru/rest/1/код/.
  2. Там же создайте «Исходящий вебхук» на событие «Обновление сделки» (или лида) с адресом с вкладки Битрикс24 и скопируйте его токен.
  3. Вставьте адрес и токен на вкладку, нажмите Сохранить и проверить, выберите направление и стадии, включите связку.

Передаётся то же, что в amoCRM: контакт и сделка или лид, стадии оплаты и возврата, комментарии в таймлайне, прогресс. Сделка, перешедшая в стадию выдачи доступа, открывает ученику курс. Кнопка Выгрузить историю один раз передаёт прошлые заказы и оплаты за период до 12 месяцев без дублей.

Если у школы включена встроенная CRM UMIWEB, связки работают параллельно с ней - сделки будут создаваться в двух местах.

1С

1С обычно стоит в закрытой сети, поэтому обмен запускает сама 1С: обработка забирает новые заказы, оплаты и возвраты по API, создаёт документы «Реализация (услуги)» и поступления и возвращает номера документов в заказы. Оплата по счёту, отмеченная в 1С, открывает ученику доступ к курсу.

  1. На вкладке 1С нажмите Создать ключ для 1С - с правами orders:read, orders:write, users:read.
  2. Передайте разработчику 1С модуль обработки обмена и инструкцию - ссылки на вкладке.
  3. В блоке Сопоставление укажите организацию школы, ИНН, КПП, ставку НДС и номенклатуру - общую или для каждого курса, и включите обмен.
Вкладка «1С»: как работает обмен, сопоставление номенклатуры и НДС, файл заказов за период.
Вкладка «1С»: как работает обмен, сопоставление номенклатуры и НДС, файл заказов за период.

Если у 1С нет доступа в интернет, выгрузите Файл заказов за период в XML или Excel и загрузите его той же обработкой. Загрузка сотрудников из 1С:ЗУП - в кадровом документообороте.

Журнал API

Вкладка Журнал API - последние 1 000 запросов за 90 дней: время, ключ, метод, адрес, код ответа, ошибка, IP-адрес и время выполнения. Фильтры по ключу и коду ответа помогают найти, почему интеграция не работает: 401 - неверный ключ, 403 - не хватает прав или запрос с чужого IP, 422 - ошибка в данных, 429 - превышен лимит.

Статья помогла?

Справка описывает панель управления LMS-платформы umiweb для администратора школы или учебного центра. Если интерфейс у вас отличается или что-то работает не так, как описано, напишите в техподдержку.