WebHook — интеграция с внешними системами

В системе PARTS SOFT доступна настройка WebHook для интеграции магазина с внешними сервисами. WebHook обеспечивает автоматическую отправку уведомлений при создании, изменении или удалении объектов в системе.

Этапы настройки WebHook:

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

Создание веб-хука

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

ШАГ 1. В панели администрирования перейдите в раздел Справочники → Интеграции → Веб-хуки и нажмите кнопку Создать.

ШАГ 2. На открывшейся странице выполните следующие действия:

Таблица 1. Настройки веб-хука

№	Название поля	Описание
1	Модель	Выберите модель веб-хука в зависимости от цели действия. В нашем примере — Лид заказа обратного звонка (при включенных лидах в Сайт-Общие настройки).
2	Метод запроса	Выберите метод запроса: POST GET В нашем примере — POST.
3	Адрес запроса	Адрес запроса вы укажете позже, после его создания.
4	Активен	Активируйте опцию, чтобы запустить веб-хук.
5	На создание	Выберите это действие, если веб-хук создается для обработки событий создания новой информации.
6	На обновление	Выберите это действие, если веб-хук создается для обработки событий обновления информации.
7	На удаление	Выберите это действие, если веб-хук создается для обработки событий удаления информации.
8	Отправлять JSON в POST
9	Тело POST запроса	Введите тело POST-запроса, который будет отправлять во внешнюю систему информацию, например, о том, что пришел запрос на обратный звонок. Доступны переменные Liquid с корневой переменной item. Под именем item будет инициализирован объект, который вы выбрали в поле Модель. Подробнее о доступных переменных — в статье Шаблоны и переменные (письма, смс и т.д.). Если запрос содержит спецсимволы, его необходимо кодировать с помощью функции url_encode.
10	HTTP заголовки

Нажмите кнопку Сохранить.

Создание веб-хука

ШАГ 3. Получите тестовый адрес запроса. Для этого перейдите в сервис Webhook.site.

Скопируйте веб-хук в поле Your unique URL.

Получение тестового адреса

ШАГ 4. Вернитесь в настройки веб-хука и укажите скопированный URL в поле Адрес запроса.

Адрес запроса

Сохраните изменения.

ШАГ 5. В панели администрирования перейдите в раздел Сайт → Общие настройки и активируйте опцию Учитывать лиды.

Сохраните изменения.

Активация опции

Тестирование веб-хука

Для тестирования веб-хука отправим запрос на обратный звонок и проверим, придет ли уведомление.

ШАГ 1. Сделайте запрос на обратный звонок в клиентской части вашего сайта.

Форма обратного звонка

ШАГ 2. В панели администрирования перейдите в раздел Справочники → Интеграции → Веб-хуки и в строке нужного веб-хука нажмите кнопку Лог срабатываний.

Переход к логу

В случае успешной настройки в таблице появится событие с информацией о времени и количестве попыток отправки веб-хука.

Полученный веб-хук

В сервисе Webhook.site видим информацию о полученном запросе.

Проверка в сервисе для тестирования

Веб-хуки на одно событие отправляются до трех раз, если endpoint не выдал ответ 200. Ожидаемое время ответа клиентского сервиса — 3 секунды.

Первая отправка отправляется через 5 секунд, вторая — через 240, третья — через 480.

В заголовке запроса отправляется заголовок PS-WEBHOOK_EVENT-ID, в котором указывается ID запроса. Этот заголовок можно использовать в клиентской части для идентификации запроса и проверки уникальности.

Настройка веб-хука с отправкой информации в JSON

Рассмотрим пример отправки информации о создании нового заказа в формате JSON.

ШАГ 1. В панели администрирования перейдите в раздел Справочники → Интеграции → Веб-хуки и нажмите кнопку Создать.

ШАГ 2. На открывшейся странице выполните следующие действия:

Таблица 2. Настройки веб-хука в формате JSON

№	Название поля	Описание
1	Модель	Выберите модель веб-хука в зависимости от цели действия. В нашем примере — Заказ клиента.
2	Метод запроса	Выберите метод запроса: POST GET В нашем примере — POST.
3	Адрес запроса	Адрес запроса вы укажете позже, после его создания.
4	Активен	Активируйте опцию, чтобы запустить веб-хук.
5	На создание	Выберите это действие, если веб-хук создается для обработки событий создания новой информации.
6	На обновление	Выберите это действие, если веб-хук создается для обработки событий обновления информации.
7	На удаление	Выберите это действие, если веб-хук создается для обработки событий удаления информации.
8	Отправлять JSON в POST	Активируйте опцию, чтобы использовался формат JSON.
9	Тело POST запроса	Не трогайте эту опцию. Тело POST запроса не используется при использовании JSON.
10	HTTP заголовки

Нажмите кнопку Сохранить.

Создание веб-хука с использованием JSON

ШАГ 3. Получите тестовый адрес запроса. Для этого перейдите в сервис Webhook.site.

Скопируйте веб-хук в поле Your unique URL.

Получение тестового адреса

ШАГ 4. Вернитесь в настройки веб-хука и укажите скопированный URL в поле Адрес запроса.

Адрес запроса

Сохраните изменения.

ШАГ 5. Внесите изменения в заказ клиента, чтобы заказ обновился и сработал веб-хук на обновление.

Для этого в панели администрирования перейдите в раздел Заказы клиента → По группам и в строке нужного заказа нажмите кнопку Редактировать. 

Внесите изменения, например, добавьте комментарий к заказу.

Сохраните изменения.

Обновление клиентского заказа

ШАГ 6. Проверьте срабатывание веб-хука.

В панели администрирования перейдите в раздел Справочники → Интеграции → Веб-хуки и в строке нужного веб-хука нажмите кнопку Лог срабатываний.

Переход к логу веб-хука

В случае успешной настройки в таблице появится событие с информацией о времени и количестве попыток отправки веб-хука.

Полученный веб-хук

В сервисе Webhook.site видим информацию о полученном запросе.

Проверка в сервисе для тестирования

Видео по теме

YouTube

RuTube