Webhook для оповещения клиента о произошедшем: GET, POST, PUT, DELETE CS-Cart и Multi-Vendor

Модуль помогает выстроить общение между вашим сайтом и сторонними интеграциями с различными сервисами: CRM системами, программами складского и бухгалтерского учета, программами рассылки уведомления на SMS, на электронную почту, в мессенджеры и социальные сети, с чат-ботами для Telegram, Viber, ВКонтакте, Facebook, Instagram и другими интеграциями для передачи событий.

Взаимодействие со сторонними сервисами

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

Однако это сильно повышает нагрузку на сайт, особенно если учесть, что таких запросов от разных программ может быть очень много и очень часто. Кроме того, это не безопасно и серьезно снижает надежность сайта.

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

Функционал модуля

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

После настройки сценария он начинает работать так: в случае наступления событий, настроенного как триггер, модуль отправляет на указанный URL. Сторонний сервис, получив информацию о наступлении события внешний ресурс, стучится по API и запрашивает детализацию информации. Дальше уже запускается ваш сценарий, настроенный на стороне внешнего сервиса.

Настраивая сценарий, вы можете выбрать один из 4 методов отправки запроса:

• GET — получение информации о событии на вашем ресурсе,
• POST — создание события на внешнем ресурсе,
• PUT — обновление информации о событии на вашем ресурсе,
• DELETE — Запрос на удаление информации на ресурсе.

Возможные сценарии работы

Опишем несколько возможных сценариев. Например, вы хотите добавить сценарий с триггером по изменении статус заказа "Оплата по счету". Вы даете задание разработчику и но он работает только с 1С. С другими программами не работает, и с кодом CS-Cart и тем более нет у него желания разбираться. Но для работы у него есть API CS-Cart на основе которого он напишет обработчик для вашей конфигурации. Вы ставите модуль, указываете ссылку для запроса информации о событии на вашем сайте. Когда происходит событие на внешний ресурс уходит информация о том, что появился в статусе заказа "Оплата по счету", внешний сервис автоматически запрашивает детальную информацию о заказе и на формирует договор или Договор-счет. Дальше в зависимости от настроек отправляет счет или в интерфейс сайта или на электронную почту покупателю. После этого статус заказа может изменить на «Выставлен счет». Когда покупатель оплатит счет, 1С также отправит информацию о смене статуса на «Оплачено».

Еще один возможный сценарий – это взаимодействие с CRM. Например, статус заказа меняется на «Обсудить с менеджером», модуль стучится в CRM и сообщает, что есть заказ на обсуждение. CRM забирает подробную информацию о заказе и передает ее менеджеру, а далее уже от сценария.

На данный момент модуль работает с сущностью «Заказ» и отправляет информацию о двух полях: ID и статус заказа.

Если вам необходима работа с другими сущностями, например, с информацией от других модулей, или увеличить список отправляемых полей, напишите нам. Мы готовы доработать модуль по вашему запросу.

Подробная инструкция по работе с модулем

Инструкция актуальна на момент публикации. Модуль регулярно обновляется и улучшается. Возможны незначительные отличия в управлении модулем.

Модуль помогает выстроить общение между вашим сайтом и сторонними интеграциями с различными сервисами: CRM системами, программами складского и бухгалтерского учета, программами рассылки уведомления на SMS, на электронную почту, в мессенджеры и социальные сети, с чат-ботами для Telegram, Viber, ВКонтакте, Facebook, Instagram и другими интеграциями для передачи событий.

Настройка модуля

1. Перейдите в пункт меню "Дополнительные настройки" - "Скачанные модули". 

2. Откроется список скачанных модулей. Найдите в списке модуль "Вебхуки". Нажмите на название, чтобы войти в настройки модуля. 

3. На открывшейся странице перейдите во вкладку "Настройки". 

4. В случае, если лицензионный ключ не выставлен автоматически и настройки модуля будут заблокированы, пройдите в ваш аккаунт на www.maurisweb.ru скопируйте лицензионный ключ и вставьте его в соответствующий пункт. Ключ так же отправлен на вашу электронную почту.

5. В разделах "Доступные домены" и "Тестовые домены" проверьте верность указанных доменов. Вы можете добавить дополнительные домены, нажав на белую кнопку "Добавить домен" в правой стороне страницы. Общее количество доменов не должно превышать трёх.

Функционал модуля

1. Перейдите в пункт меню "Веб-сайт" - "MW: Вебхуки".

2. Чтобы создать новый вебхук, нажмите на кнопку в виде плюса в правом верхнем углу. 

3. Введите название вебхука. 

4. Введите URL , с которого будет приходить информация. 

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

6. Выберете метод передачи. 

• GET — получение данных с сервера (чтение). Безопасный, не изменяет данные.
• POST — отправка данных на сервер для создания новой сущности (создание).
• PUT — полное обновление существующей сущности или создание с известным ID (обновление/создание).
• DELETE — удаление сущности с сервера (удаление).

7. Перейдите во вкладку "Триггеры".

8. Поставьте галочки напротив статусов, которые нужно передавать. 

9. Перейдите во вкладку "Список отправляемых полей". 

10. Отметьте галочками поля, которые необходимо передавать. 

11. Нажмите кнопку "Создать" в правом верхнем углу. 

12. Для редактирования вебхука нажмите на его название в списке вебхуков. 

13. Чтобы удалить вебхук, нажмите на шестеренку справа от него и выберете пункт "Удалить". 

14. Для массового удаления выберете вебхуки, которые нужно удалить, нажмите на шестеренку в правом верхнем углу и выберете пункт "Удалить выбранные".