Документация по API https://docs.zenclass.ru
Для интеграции сервисов с помощью API необходимо создать токен. Это можно сделать в разделе Настройки школы - Основные настройки - API
Количество выпущенных токенов не ограничено. Необходимо выпускать отдельные токены для разных интеграций.
К каждому токену можно добавить комментарий, чтобы понимать, к какому сервису он относится, и в дальнейшем не путать токены.
*Обратите внимание, что к токену необходимо относиться как к паролю: не сообщайте его посторонним, т.к. с использованием вашего токена можно вносить изменения в ваш личный кабинет Zenclass.
Разрешения токенов
При создании токена можно указать точечные разрешения (scopes). Например, один токен может быть предназначен для создания студентов, а другой для создания заказов. Каждое разрешение относится к группе методов API. На данный момент, в Zenclass доступны следующие разрешения:
scope | Пояснение |
school | Разрешение для работы с методами из группы "Школа" |
student | Разрешение для работы с методами из группы "Студенты" |
student_course | Разрешение для работы с методами из группы "Студент + Курс" |
auto_login_link | Разрешение для работы с методами из группы "Вход" |
Для установки разрешения необходимо сначала создать токен после чего нажать на значок редактирования токена.
Если токен ранее был создан, то необходимо также нажать на значок редактирования токена и выбрать разрешения. Внесенные изменения потребуется сохранить.
Как найти ID курса
Перейдите в настройки курса в раздел Встраивание. ID данного курса будет указан в прямой ссылке на курс.
Как найти ID тарифа
Перейдите в раздел Оплата и тарифы конкретного курса, откройте раздел Доступ нужного тарифа и скопируйте прямую ссылку на данный тариф.
Скопированную ссылку на тариф вставьте в любой текстовый редактор - в окончании ссылки указан ID тарифа.
Как найти ID ученика
Перейдите в профиль ученика, нажав на его имя. В адресной строке браузера в ссылке будет указан ID данного ученика.
*Для идентификации ученика можно использовать не только его ID, но и email.