Вебхук — инструмент передачи данных между разными системами. Вебхуки позволяют получать автоматические уведомления о событиях Exely Suite, например, создании или отмене бронирования.
Чтобы настроить вебхуки, в экстранете Exely перейдите в раздел «Настройка гостиницы» → «Подключение API».
Настройка вебхуков происходит при создании подключения. Также вы можете изменить настройки в уже созданном подключении.
В таблице нажмите на название подключения. На открывшейся странице перейдите на вкладку «Вебхуки».
Если подключение было создано без вебхуков, в пункте «Использование вебхуков» будет выбрано «Нет».
Чтобы перейти к настройке вебхуков, выберите «Да». На странице появятся блоки с дополнительными настройками.
Данные для вебхуков
В пункте «URL» введите URL вашего сервера, который будет принимать уведомления. URL — адрес веб-страницы.
Обратите внимание. URL должен:
содержать протокол HTTPS — безопасный протокол передачи данных.
быть доступен для получения событий.
В пункте «Настройка аутентификации» выберите способ аутентификации запросов:
Без аутентификации — уведомления будут отправляться без дополнительной проверки.
API-ключ — уведомления будут отправляться с API-ключом для защиты запросов. Ключ будет передаваться в заголовке запроса.
Пример: 'API-KEY: Hgd529ltv08Su2RKQB/jjWe629'
API-KEY — имя ключа, Hgd529ltv08Su2RKQB/jjWe629 — сам ключ.
Basic Auth — метод закрытия доступа к веб-сайту с помощью логина и пароля. Уведомления будут отправляться с логином и паролем в заголовке запроса авторизации.
Пример:
События для отслеживания
Активируйте события, о которых вы хотите получать уведомления.
Все события сгруппированы по решениям и категориям. Например, в решении Exely PMS перечислены категории, которые относятся к Exely PMS — бронирования, заезды, уборка, гости и т. д.
В каждой категории перечислены события, которые будут отправляться на указанный вами URL.
Чтобы отменить все события в категории, нажмите «Отменить все», затем выберите необходимые вручную.
Обратите внимание. Список решений может отличаться. Он зависит от решений Exely, с которыми вы работаете в экстранете.
Нажмите кнопку «Сохранить» на верхней панели, чтобы сохранить настройки и активировать вебхук.
Обратите внимание. При изменении URL или событий требуется повторное сохранение настроек.
Как проверить отправку вебхуков
1. Уведомления отправляются в формате JSON.
2. Убедитесь, что ваш сервер при отправке уведомлений возвращает статус «200 OK». Для проверки воспользуйтесь специальными сервисами, например, webhook.site.
3. Если возникли проблемы при отправке вебхуков, проверьте:
доступность URL,
корректность API-ключа, если используется аутентификация,
настройки брандмауэра (межсетевой экран) вашего сервера.
Если у вас остались вопросы по настройке и отправке вебхуков, направьте запрос вашему сопровождающему менеджеру Exely или в службу поддержки Exely.