> For the complete documentation index, see [llms.txt](https://docs.skillzrun.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.skillzrun.com/administruvannya/robota-z-api.md).

# Робота з API

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

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

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

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

<figure><img src="https://135744108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjgRDsyXtfduYZJEtYHGk%2Fuploads%2FpE177OZinEJhSyXqD4pS%2Fapi1.png?alt=media&#x26;token=f5f1297e-8059-48a1-813c-df06cf4307f6" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://135744108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjgRDsyXtfduYZJEtYHGk%2Fuploads%2Fm6mVrj0tu1O6vecM3odf%2Fapi2.png?alt=media&#x26;token=b779b74f-5bef-4f30-ab97-07a52976526d" alt=""><figcaption></figcaption></figure>

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

#### ✔︎ Ви можете переглянути документацію для роботи з API [тут.](https://api.skillzrun.com/external/api/swagger/static/index.html#/)

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

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

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

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

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

{% hint style="info" %} <mark style="color:$info;">Всі актуальні апі-методи ви знайдете за посиланням</mark>

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

<mark style="color:$info;">Доступ там запаролений, ви отримаєте логін та пароль звернувшись до тех підтримки.</mark>
{% endhint %}

<a href="https://t.me/SkillzRunSupport_bot" class="button primary">Підтримка в Телеграм</a>

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

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

* `userIds` — масив ID користувачів;
* `amount` — зміну балансу: додатне число для нарахування, від'ємне для списання;
* `note` — примітку до зміни балансу.

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

Покроковий опис параметрів: [масове оновлення балансу монет](https://docs.skillzrun.com/administruvannya/robota-z-api/masove-onovlennya-balansu-monet).

***

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

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

[Довідник методів зовнішнього API](/administruvannya/robota-z-api/dovidnik-metodiv-zovnishnogo-api.md)

***

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

<details>

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

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

</details>

<details>

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

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

</details>