Перейти к основному содержанию
API школы позволяет внешним системам работать с данными школы без участия сотрудников: создавать и находить пользователей, записывать их на курсы, читать прогресс, доступы и счета, синхронизировать сотрудников, запускать выгрузки. API построено по принципу REST и работает по HTTPS. Эта статья — обзор: как получить ключ и какие правила действуют. Описание всех методов, параметров и ответов — в документации для разработчиков: docs.exode.biz.

​
API-ключи

Запросы к API выполняются от имени служебного пользователя — API-ключа. У каждого ключа свой токен и свой набор прав. Ключи находятся в разделе Панель управления → Моя школа → Для разработчиков → API-ключи (в корпоративной школе — Панель управления → Компания → Для разработчиков → API-ключи).
  • Просматривать, выпускать и перевыпускать ключи может только владелец школы.
  • В школе может быть не больше 5 ключей.
В списке ключей для каждого ключа показаны адрес служебного пользователя, начало и конец токена, число прав, состояние Активен или Не активен и дата выпуска.

​
Как выпустить ключ

1

Нажмите «Создать API-ключ»

Платформа создаст служебного пользователя и выпустит для него токен.
2

Сохраните токен

В окне API-ключ скопируйте токен и сохраните его в надёжном месте. Токен показывается целиком только один раз. Потом в списке видно только его начало и конец.
3

Скопируйте идентификаторы

Ниже списка ключей, в блоке Данные для интеграции, нажмите карточку Идентификаторы. В буфер попадут оба идентификатора, которые нужны в каждом запросе: Seller-Id и School-Id.
4

Проверьте права

В меню ключа выберите Редактировать, отметьте нужные права и нажмите Сохранить.

​
Права ключа

Новый ключ сразу получает права, которые нужны методам API: управление пользователями, курсами, учениками, формами и базой заданий. Коммерческие школы дополнительно получают права Продажи школы и Возвраты школы, школы для корпоративного обучения — права на управление и просмотр персонала. Права сгруппированы по разделам: Управление школой, Управление курсами, Управление формами и другие. Оставьте ключу только те права, которые нужны интеграции. Если у ключа нет нужного права, метод вернёт ошибку доступа. Какие права нужны каждому методу, описано в документации API.

​
Выключение и перевыпуск

  • Чтобы временно остановить интеграцию, выключите ключ переключателем в списке. Запросы с его токеном перестанут проходить, пока ключ не включат снова.
  • Если токен потерян или мог попасть к посторонним, выберите в меню ключа Перевыпустить API-ключ и подтвердите. Старый токен перестаёт работать сразу, новый показывается один раз.
У токена нет срока действия: он работает, пока ключ не перевыпустят.
Токен даёт доступ к данным школы в объёме прав ключа. Храните его только на своём сервере. Не вставляйте токен в кастомный код школы, мобильные приложения и код, который выполняется в браузере.

​
Как отправлять запросы

Адрес методов строится так: https://api.exode.biz/saas/v2/ плюс путь метода из документации. В каждом запросе передайте три заголовка:
Ответ приходит в формате JSON. В успешном ответе поле success равно true, а данные лежат в поле payload. В ответе с ошибкой success равно false, а причина — в полях cause и message. Для сервера на Node.js есть готовый клиент — пакет @exode-team/sdk. Подробнее — в разделе Exode SDK.

​
Что можно делать через API

Вебхуки через API не настраиваются — только в кабинете. См. Вебхуки.

​
Ограничения

Лимиты отдельных методов указаны в документации API.

​
Частые вопросы

Посмотреть токен повторно нельзя: целиком он показывается только при выпуске. Перевыпустите ключ через Перевыпустить API-ключ и обновите токен в своей интеграции.
Работать с API-ключами может только владелец школы — даже сотрудник со всеми правами не сможет выпустить или перевыпустить ключ. Попросите владельца выпустить ключ и передать токен разработчику по защищённому каналу.
В школе уже 5 ключей. Перевыпустите один из существующих ключей вместо создания нового. Если ключей действительно не хватает, напишите в поддержку.
Проверьте, что ключ включён, токен передан в заголовке Authorization после слова Bearer, а заголовки Seller-Id и School-Id взяты из блока Идентификаторы вашей школы. Затем проверьте права ключа: у метода должно быть нужное право.
Токен не истекает. Он перестаёт работать, только если ключ перевыпустили или выключили.
Нет. Любой, кто получит токен, сможет работать с данными школы. Отправляйте запросы к API только со своего сервера.
Нет. Идентификаторы относятся к школе и не меняются при перевыпуске токена.
Используйте вебхуки: платформа сама отправит запрос на ваш адрес, когда произойдёт событие. См. Вебхуки.
Обновлено: 2026-10-15 18:08 UTC