Адміністрування школи
Підключення ваших систем через 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: список ваших учнів з фільтрами й пошуком або одного учня за ідентифікатором користувача чи адресою електронної пошти, разом із його групами, виконаними завданнями, оцінюваннями й часом навчання.
- Classes: список ваших груп або одну групу з викладачем і списком учнів.
- Auth: перевірка того, що ваш ключ працює.
Повний довідник із прикладами на PHP, Python і JavaScript наведено в документації API. Ваш розробник може випробувати кожен ендпоінт у браузері на сторінці тестування, посилання на яку є там.
Зберігайте ключ так само надійно, як пароль. Тримайте його на своєму сервері й ніколи не розміщуйте на вебсторінці чи в застосунку. Якщо ви вважаєте, що ключ став відомий стороннім, негайно зверніться до Smrt English.
