Администрирование школы
Подключение ваших систем через API Smrt English
Получайте данные об учащихся и группах вашей школы в собственных системах с помощью API-ключа от Smrt English.
API Smrt English позволяет системам вашей школы, например информационной системе учащихся или панели отчетности, получать данные о ваших учащихся и группах. API работает только на чтение: он не может добавлять, изменять или удалять данные в Smrt English.
Как получить API-ключ
Чтобы запросить API-ключ (API key) для вашей школы, свяжитесь с Smrt English. Ключи выдает и обслуживает Smrt English. Ключ всегда возвращает только учащихся и группы вашей школы.
Когда у школы появится ключ, откройте Dashboard, нажмите Home, затем Settings. В блоке Client API показано, сколько ключей активно и сколько запросов они сделали за последние 30 дней.
Передайте ключ специалисту, который делает интеграцию. Он передает ключ в заголовке X-API-Key каждого запроса.
Какие данные доступны
- Учащиеся (Students): список ваших учащихся с фильтрами и поиском или один учащийся по ID пользователя или адресу электронной почты, включая его группы, выполненные задания, тесты и время, затраченное на обучение.
- Группы (Classes): список ваших групп или одна группа с преподавателем и списком учащихся.
- Проверка ключа (Auth): тест, который проверяет, что ключ работает.
Полный справочник с примерами на PHP, Python и JavaScript находится в документации API. Разработчик может проверить каждый эндпоинт в браузере на странице тестирования, ссылка на которую есть там же.
Храните ключ так же бережно, как пароль. Держите его на своем сервере и никогда не размещайте на веб-странице или в приложении. Если вы подозреваете, что ключ стал известен посторонним, сразу свяжитесь с Smrt English.
