Partner API: ключі та вебхуки
За допомогою Partner API підключаєш власні сторінки бронювання, застосунки та інтеграції до STRYK. Ти створюєш ключі лише з потрібними правами та налаштовуєш вебхуки.
Contents
Перш ніж почати
- Тобі потрібне право Керуй каналами. Лише з ним бачиш рядок API на сторінці Канали.
- З'ясуй, які розділи інтеграція має читати або змінювати. Ключ отримує лише ці права.
- Інтеграція викликає Partner API зі свого сервера. Ключ ніколи не вноси в код браузера чи застосунку. Ендпоінти, параметри та приклади знайдеш у Документації для розробників. Розділ Автентифікація та області доступу там пояснює, що дозволяє кожне право.
- Вебхукам потрібен отримувач з адресою, яка починається з https://.
Відкриття API
In STRYKКанали
- Обери в розділі Власні підключення рядок API з приміткою „API-ключі та вебхуки“. Відкриється діалог API.
- Обери вкладку API-ключі або Вебхуки. Кнопкою Документація для розробників у заголовку діалогу відкриваєш портал розробників.
- Вкладки API-ключі і Вебхуки
- Ключі з правами
- Дії з ключем
Створення API-ключа
In STRYKКаналиAPIAPI-ключі
- Обери Створити API-ключ. Відкриється діалог Створити API-ключ.
- Введи Ім'я, наприклад „Сторінка бронювання“.
- Обери в Права шаблон: Лише читання (читання всіх розділів), Читання і запис (запис там, де це можливо) або Користувацьке. Для Користувацьке обери для кожного розділу Без доступу, Читання або Запис. Розділи: Готель і номери, Доступність, Ціни й тарифи, Бронювання, Гості, Платежі та Рахунки. Запис включає Читання. Рахунки є фіскальними документами готелю і через API доступні лише для читання.
- Необов'язково: відкрий Просунутий. Обери Термін дії: Без терміну, 30 днів, 90 днів, 1 рік або Дата (з завтра, максимум на три роки). Внеси в Обмеження IP для кожного рядка адресу або мережу CIDR, максимум 20. Порожнє поле дозволяє всі адреси. У Примітка залиш внутрішню нотатку.
- Обери Створити. STRYK покаже API-ключ створено з ключем і позначкою Видно лише зараз.
- Скопіюй ключ і збережи його, наприклад, у менеджері паролів. Обери Готово.
Керування ключами
In STRYKКаналиAPIAPI-ключі
Список показує для кожного ключа Ім'я, початок ключа, Права, Створено, Останнє використання, Термін дії та статус: Активний, Незабаром спливає, Відкликано або Термін дії минув. Обери ключ, щоб побачити Права, Термін дії, Дозволені IP-адреси, Ліміт запитів (запитів за хвилину), Використання, Останні запити та Історію.
- Відкрий у рядку меню Опції.
- Обери Перегенерувати, якщо інтеграція має отримати новий ключ з тими ж правами. Обери в Поточний ключ Старий ключ дійсний ще 24 год, щоб перемкнути інтеграцію, або Відкликати одразу. Підтверди кнопкою Перегенерувати. STRYK покаже новий ключ один раз.
- Обери Відкликати і підтвердь Відкликати API-ключ?, щоб одразу заблокувати ключ. Запити з цим ключем STRYK тоді відхиляє.
Налаштування вебхуків
In STRYKКаналиAPIВебхуки
Вебхук надсилає вибрані події підписаними через HTTPS до твоїх систем.
- Обери Створити вебхук. Відкриється діалог Новий вебхук.
- Введи URL отримувача, наприклад https://crm.nordlicht.invalid/hooks/stryk. Адреса має починатися з https://.
- Необов'язково: введи Опис, наприклад „Бронювання до нашої CRM“.
- Обери в Події принаймні одну: Бронювання створено, Бронювання змінено, Бронювання скасовано, Гостя змінено, Доступність змінено, Ціну змінено, Платіж змінено або Статус номера змінено. Кнопками Вибрати все та Скасувати вибір обираєш усі або жодної.
- Обери Створити вебхук. STRYK покаже Твій секрет підпису один раз.
- Збережи секрет у своєму отримувачі. Як отримувач перевіряє підпис, описано в документації для розробників у розділі Вебхуки та перевірка підпису.
- Обери вебхук, а потім Надіслати тестову подію. STRYK повідомляє „Тестова подія доставляється.“
Керування вебхуками
Ort: Канали > API > Webhooks, обрати вебхук
- Перемикачем Доставку ввімкнено призупиняєш або активуєш вебхук. Призупинені вебхуки не отримують подій. Після активації доставка починається з нових подій.
- Останні 7 днів, Останній успіх і Остання помилка показують стан. У Доставки бачиш кожну доставку з Статус HTTP і Спроби. Кнопкою Надіслати знову повторюєш доставку.
- Оновити секрет створює новий секрет. Попередній лишається дійсним ще 24 години, щоб ти міг перемкнути отримувача.
- Кнопкою Редагувати змінюєш адресу та події, кнопкою Видалити та підтвердженням Видалити вебхук? видаляєш його. Журнал доставок зберігається 30 днів.
Як перевірити результат
- У ключа з'являється Останнє використання з датою, щойно інтеграція його використовує. Запити 24 год показує кількість запитів.
- У вебхука Останні 7 днів показує „{Zahl} доставлено, {Zahl} з помилкою“, а тестова подія видна в Доставки.
Якщо щось не працює
| Що ти бачиш | Причина | Як це виправити |
|---|---|---|
| „Обери принаймні одне право.“ | Жодна область не має права. | Обери шаблон або дай принаймні одній області Читання чи Запис. |
| „Введи, будь ласка, ім'я.“ | Бракує Ім'я. | Введи ім'я. |
| „Будь ласка, перевір:“ з адресою | Адреса в Обмеження IP недійсна. | Виправ адресу або мережу CIDR. Дозволено максимум 20 записів. |
| „Обери дату з завтрашнього дня, не пізніше ніж за три роки.“ | Термін дії лежить поза допустимим періодом. | Обери дату з завтрашнього дня, але не далі ніж за три роки. |
| „Адреса має починатися з https://.“ | URL отримувача не є адресою HTTPS. | Введи адресу з https://. |
| „Обери принаймні одну подію.“ | У вебхука немає жодної події. | Обери принаймні одну в Події. |
| Призупинено через повторні помилки | Отримувач не відповідає статусом 2xx. | Перевір, чи доступний отримувач, і обери Знову активувати. |
| „Активуй вебхук, щоб надіслати тестову подію.“ | Вебхук призупинено. | Увімкни Доставку ввімкнено і надішли тестову подію. |
| „Вибір не вдалося завантажити. Закрий і відкрий його знову.“ | Список прав і подій не завантажено. | Закрий діалог і відкрий його знову. |