У WeStudy сталася подія — як повідомити зовнішню систему через API або webhook?

Якщо готової інтеграції недостатньо, нову LMS-платформу WeStudy можна пов'язати із зовнішньою системою за допомогою підтримуваних API-запитів або webhook-подій.

Ця інструкція призначена для технічного спеціаліста.

У чому різниця

API-запит використовується, коли зовнішня система самостійно звертається до WeStudy, щоб отримати або передати доступні дані.

Webhook працює у зворотному напрямку: WeStudy повідомляє вказану адресу, коли відбувається підтримувана подія.

Наприклад, система може отримати повідомлення після створення заявки, якщо така подія доступна в налаштуваннях.

Опишіть сценарій

Перед налаштуванням дайте відповіді на чотири запитання:

1. Яка подія відбувається у WeStudy?

2. Які дані потрібно передати?

3. Яка зовнішня система має їх отримати?

4. Яку дію вона повинна виконати?

Не починайте з технічного підключення без готового сценарію.

Перевірте підтримку події

Відкрийте актуальну документацію або налаштування інтеграцій WeStudy.

Перевірте:

• чи доступна потрібна подія;

• які поля передаються;

• який формат даних використовується;

• як виконується авторизація;

• які обмеження діють для запитів.

Підготуйте тестову адресу

Для webhook потрібна захищена HTTPS-адреса, яка може приймати запити. Для API підготуйте тестове середовище або інструмент, у якому можна безпечно виконати контрольний запит.

Не вставляйте секретні ключі у відкритий код, скриншоти або текст інструкції.

Налаштуйте авторизацію

Створіть окремі тестові облікові дані з мінімально необхідними правами.

Збережіть ключі в захищеному середовищі та визначте відповідального за їх оновлення.

Створіть підключення

Для webhook укажіть адресу отримувача та виберіть підтримувану подію.

Для API сформуйте запит відповідно до документації: метод, адресу, заголовки, параметри й тіло запиту.

Виконайте контрольну подію

Створіть тестову заявку, користувача або іншу підтримувану подію в WeStudy.

Зафіксуйте час виконання, щоб швидко знайти відповідний запит у зовнішній системі.

Перевірте отримані дані

Переконайтеся, що зовнішня система отримала:

• правильний тип події;

• ідентифікатор запису;

• потрібні поля;

• коректний час;

• значення без спотворень.

Перевірте помилки й повтори

Зовнішня система має коректно реагувати, якщо запит:

• надійшов повторно;

• містить порожнє необов'язкове поле;

• тимчасово не може бути оброблений;

• має неправильну авторизацію.

Результат

Зовнішня система отримує підтверджену подію з LMS-платформи WeStudy та виконує заплановану дію без дублювання або втрати даних.