Что такое вебхук, как и зачем его использовать

Что такое вебхук, как и зачем его использовать

На своих веб-сайтах организации часто публикуют заметки о предстоящих событиях для персонала, партнеров и обычных посетителей. Это могут быть различные акции, сезонные распродажи, обновление ассортимента, создание новых структурных подразделений, а также открытие дополнительных филиалов. Немаловажно при этом выстроить информационный обмен с другими сервисами, например, с сайтами дилеров. Помощь в интеграции данных и выборе их получателей окажет webhook.

Что из себя представляет webhook

Вебхук является одним из методов информирования пользователей веб-сайта. При изменении данных на площадке сервером создается HTTP-вызов и сведения отправляются пользователю посредством вебхука. Уведомление будет содержать наименование события и ссылку на него. К примеру, в складскую базу занесли новую продукцию. Система уведомит пользователей программы посредством вебхука.

Как выглядит

Вебхук представляет из себя программный код, при помощи которого выполняется отслеживание изменений на одном сайте и передача данных об этом на другой. Обновленная информация при этом доставляется получателю очень быстро.

К примеру, клиент хочет узнавать о публикациях новых комментариев на его площадке. Администратор веб-сайта выполняет настройку вебхука. Что происходит дальше:

  1. Посетитель оставляет на площадке новый комментарий.
  2. Информация загружается на сервер.
  3. Сервером вызывается URL вебхука.
  4. Пользователю приходит сообщение о публикации нового комментария.

Отличие API от webhook

Сообщения о системных обновлениях могут отправляться с помощью API или вебхука. Оба способа способствуют взаимодействию двух программ.

Работа API заключается в отправке повторяющихся запросов и получении определенных сведений в ответ. Проще говоря, пользователю надо постоянно отправлять серверу запрос для получения актуальных сведений.

Вебхук же действует как подписка: нужно один раз настроить уведомление для пользователей веб-сайта, а система в автоматическом режиме будет сообщать им о происходящих обновлениях.

Вебхук лишь сообщает о произошедших внутри системы обновлениях. Он пригодится в следующих случаях:

  • создание клиентских заказов и актуализация этапов их исполнения;
  • внесение изменений в прайс;
  • обновление контактной информации.

Для того, чтобы работать с информационными базами, требуется API. Благодаря ему можно создавать, читать, вносить корректировки в содержащиеся данные и стирать их.

Создание пробной версии вебхука

Чтобы создать пробную версию вебхука не нужна собственная площадка. Можно сделать это на сайте Webhook.site.

Алгоритм действий:

  1. Зайдите на сайт. Система создаст персональный URL для вебхука. Его нужно будет скопировать.
  2. Перейдите на интересующем вас сайте к настройкам, выберете функцию webhook. Откроется окно для выполнения настроек.
  3. Далее в строку для URL нужно будет вставить полученную ранее ссылку. В графе «Тип контента» либо Content type нужно будет выбрать application/json. Далее выбрать тип изменений, о которых нужно будет уведомлять.
  4. Теперь вебхук можно сохранить и вернуться в раздел Webhook.site. При правильном выполнении перечисленных действий поставщик данных ответит на ваш запрос. В левой части можно будет увидеть само оповещение, а в правой — уточнение запроса.

Безопасность применения

Вебхуки передают информацию посредством публичных URL. При этом адреса могут быть перехвачены, а сведения в них подменены.

Чтобы обезопасить себя, следует придерживаться следующих советов:

  • Рекомендуется пользоваться протоколом HTTP — HTTP, поддерживающим кодирование.
  • URL лучше создавать с персональной идентификацией.
  • Аутентифицировать вход в webhook лучше через HTTP Basic authentication. Сервис попросит указать логин и пароль.
  • Сотрудничать лучше с провайдерами, защищающими информацию идентификационным кодом, таким как HMAC.

Ограничения при использовании вебхуков

Тем, кто решил воспользоваться вебхуками, следует учесть, что возможность их настройки имеется только у администратора сайта, работа осуществляется исключительно через JSON API.

Как проверяется эффективность вебхука

Эффективность вебхука проверяется на специальном сайте. Он создает пробный URL и показывает необходимый тип уведомлений.

  1. Зайдите на площадку. Из строки Your unique URL скопируйте ссылку.
  2. Создайте webhook. В поле URL вставьте сгенерированную ссылку.
  3. У себя в программе создайте любое событие. Его можно указать посредством JSON API.
  4. Проверьте появление уведомления по своей уникальной ссылке.

Подведение итогов

При помощи вебхука посетители площадки узнают об изменениях, происходящих на ней. Широко используется разработчиками программ для оповещения клиентов о появлении новых опций в системе. Создав вебхук, можно сообщать пользователям об акциях и новинках, изменении цен и новых полученных сообщениях. В настройке вебхука нет ничего сложного, главное обеспечить безопасность передачи данных.

Есть вопросы, пожелания, предложения? Пишите нам,
мы обязательно ответим.