Робота з API

Інструкція зі створення API ключа та API документація.

✔︎ Ключ API є унікальним ідентифікатором, який використовується для автентифікації запитів, пов'язаних з вашою школою.

✔︎ Для створення API ключа вашої школи потрібно бути авторизованим під ролю генерального менеджера школи.

✔︎ Перейдіть до налаштувань школи натиснувши на "Шестірню" поряд з іконкою школи.

✔︎ Перейдіть до вкладки "API КЛЮЧІ" і натисніть "Створити".

✔︎ Ви створили API ключ вашої школи, завдяки якому ви можете користуватися API.

✔︎ Ви можете переглянути документацію для роботи з API тут.

✔︎ Приклад роботи з API з параметрами, що необхідно передавати:

➀ Стандартно видається 20 записів на сторінку, щоб міняти кількість необхідно додати запис нижче:

➁ "?start=0&end=1000" до URL.

➂ Приклад: "https://api.skillzrun.com/external/api/users/?start=0&end=1000"

➃ Цифра в end після "=" вказує скільки юзерів потрібно отримати.

Всі актуальні апі-методи ви знайдете за посиланням

https://api.skillzrun.com/external/api/swagger/static/index.html#/

Доступ там запаролений, ви отримаєте логін та пароль звернувшись до тех підтримки.

Підтримка в Телеграм

Масове оновлення балансу монет

Для нарахування або списання монет кільком користувачам через зовнішнє API доступний метод PATCH /external/api/user_balance/. Передайте у тілі запиту:

• userIds — масив ID користувачів;

• amount — зміну балансу: додатне число для нарахування, від'ємне для списання;

• note — примітку до зміни балансу.

Для авторизації використовуйте заголовок x-api-key. Повний опис API й актуальні схеми запитів перевіряйте у Swagger за посиланням вище.

Покроковий опис параметрів: масове оновлення балансу монет.

---

Довідник методів зовнішнього API

Повний перелік публічних методів зовнішнього API (користувачі, баланс монет, домашні завдання, події, відгуки, структура предметів, уроки, генерація вправ, місії, слова та терміни) — на окремій сторінці:

Довідник методів зовнішнього API

---

Часті запитання

Як вивантажити всі домашні завдання або дані учнів разом, а не по одному?

Це можна зробити через API — створіть ключ у налаштуваннях компанії та скористайтесь відповідними методами. Повна документація доступна у Swagger за посиланням на цій сторінці.

Чи можлива інтеграція реєстрації через сторонні сервіси (email-розсилки, CRM тощо)?

Такі інтеграції розглядаються індивідуально під кожен випадок. Зв'яжіться з підтримкою — команда запропонує зідзвон, щоб обговорити деталі.