WebHooks

Модуль отправки данных на сторонние сервисы по стандарту Веб-хуков.

Веб-хуки позволяют по разным событиями (новый заказ, новый пользователь, редактирование заказа и т.д.) отправлять редактируемые данные на сторонние сервисы автоматизации процессов APIXDrive и Zapier.

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

Модуль доступен в административной панели магазина в меню Модули → Управление модулями → Разработчикам - WebHooks - Включить. Затем открыть модуль в меню Модули → WebHooks. Добавление нового веб-хука находится в закладке Обзор WebHooks.

В обзоре WebHooks нажмите ➕ Добавить и выберите действие срабатывания веб-хука:

1. Новый заказ

2. Изменение заказа

3. Списание товара со склада

4. Новый товар

5. Изменение товара

6. Новый пользователь

7. Изменение пользователя

В поле URL WebHook указывается уникальный адрес внешнего сервиса приема данных, например: https://s1.apix-drive.com/web-hooks/62652/lc56dfkhbq89f

Поле Название служит для комментария назначения веб-хука. Метод передачи POST или GET задается сервисом приема данных.

В Обзоре WebHooks отображаются все созданные веб-хуки.

В разделе Журнал операций отображаются все запросы со статусом ответа.

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

[parameters] => Array
        (
            [name] => 24-14
            [sum] => 800
            [date] => 25-09-2020
            [comment] => 
            [adress] => 
            [fio] => 
            [tel] => [phone]
            [tracking] => 
            [paid] => 
            [status] => Новый заказ
            [email] => [e-mail]
            [payment] => Наличная оплата
            [positions] => Array
                (
                    [0] => Array
                        (
                            [name] => Футболка Springfold 37 бледно-голубой
                            [quantity] => 1
                            [uid] => 
                            [price] => 800
                            [discount] => 0
                            [vat] => 18
                        )
                )

        )
    [response] => данные приняты

Для анализа получаемых данных от веб-хуков рекомендуем использовать сервис https://webhook.site

Интеграция с APIXDrive

ApixDrive - это простой способ «подружить» разные приложения и сервисы между собой без программирования и специальных знаний.

Регистрация

Для регистрации в APIXDrive достаточно перейти на официальный сайт и заполнить форму нового пользователя.

Создание источника связи в APIXDrive

С помощью модуля WebHooks и сервиса APIXDrive создадим функцию передачи сообщения о новом заказе в Telegram.

Перейдем в раздел Главная - ➕ Создать связь. В качестве источника данных нужно выбрать Webhook (источник). Нажимаем кнопку Продолжить.

На закладке Действие выбираем действие Принять данные. Нажимаем кнопку Продолжить.

В закладе Доступ выбираем свой аккаунт. Нажимаем кнопку Продолжить.

В закладке Настройка выводится URL для приема данных. Копируем этот URL для использования в модуле WebHooks. Нажимаем кнопку Продолжить.

В закладке Фильтр нажимаем кнопку Продолжить.

Далее нам нужно перейти в модуль WebHooks и создать новый веб-хук с URL адресом для приема данных, показанным на предыдущем шаге в закладке Настройка. В качестве действия веб-хука следует выбрать Навый заказ.

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

Переходим обратно в управление APIXDrive и нажимаем кнопку Загрузить тестовые данные из Webhook (источник). Появляется таблица данных нового заказа - это значит веб-хук сработал и передал данные в APIXDrive. Если таблицы с данными нет, то веб-хук не сработал и следует проверить его настройки. Нажимаем кнопку Далее.

На следующем этапе видим сообщение об успешной настройки и нажимаем кнопку Начать настройку приема данных.

Создание приема данных в APIXDrive

В закладке Система выбираем систему Телеграм. Нажимаем кнопку Продолжить.

В закладке Действие выбираем Отправить сообщение. Нажимаем кнопку Продолжить.

В закладке Доступ выбираем Подключить аккаунт. В появившемся окне кликните Сохранить. Далее, откроется новое окно, в котором нужно скопировать данные в поле Строка для подключения Телеграм-бота, закрыть это окно, перезагрузить страницу и выбрать созданный аккаунт. В Вашем приложении Телеграм в строке поиска введите apix-drive. Нажмите на профиль бота и кликните Запустить.

Более подробная инструкция по подключению Телеграм-бота доступна по ссылке https://apix-drive.com/ru/help/telegram. Нажимаем кнопку Продолжить.

В закладке Настройки можно указать какое сообщение будет отправлено в Телеграм. Справа в селекторе можно выбрать данные, полученные от модуля WebHooks из интернет-магазина. Нажимаем кнопку Продолжить.

У вас новый заказ №{name:none:80537} на сумму {sum:none:80537} руб.

В закладке Тест отображается пример сообщения, которое будет отправлено в Телеграм.

Можно нажать кнопку Отправить тестовые данные в Телеграм и получить это сообщение у себя в Телеграм. Нажимаем кнопку Далее.

Настройка Приема Данных успешно завершена. Нажимаем кнопку Включить автообновление.

Цепочка связей настроена и теперь вы сможете получать оповещение о новом заказе в свой Телеграм от чат-бота ApiX-Drive | Уведомления.

Интеграция с Zapier

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

Регистрация

Для регистрации в Zapier достаточно перейти на официальный сайт и заполнить форму нового пользователя.

Создание цепочи связей в Zapier

С помощью модуля WebHooks и сервиса Zapier создадим функцию передачи сообщения о новом заказе в Gmail.

Перейдем в раздел Главная - ➕ MAKE A ZAP. В качестве Choose App нужно выбрать Webhooks by Zapier. В качестве Choose Triger Event нужно выбрать Catch hook. Нажимаем кнопку COUNTINUE.

На втором шаге Customize Request появится Custom Webhook URL, который нам нужно скопировать в настройки модуля Webkooks. Нажимаем кнопку COUNTINUE.

Далее нам нужно перейти в модуль WebHooks и создать новый веб-хук с Custom Webhook URL, показанным на предыдущем шаге в закладке Customize Request . В качестве действия веб-хука следует выбрать Навый заказ.

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

На третьем шаге Find Data мы должны протестировать связь, для этого нажимаем кнопку Test triger.

Если тест пройден, то появляется таблица принятых данных из нового заказа. Если тест не прошел, то требуется проверить правильность заполнения полей в настройках модуля Webhooks. Нажимаем кнопку COUNTINUE.

На следующем этапе Choose App & Event выбираем приложение Gmail в качестве Choose App и Send Email в качестве Choose Action Event. Нажимаем кнопку COUNTINUE.

Далее выбираем свой Gmail account, с которого будет рассылаться почта. Нажимаем кнопку COUNTINUE.

Далее следует настроить параметры почтового сообщения. В качестве поля To выбираем поле Email из данных, которые пришли на этапе тестирования. В поле From выбираем свой Gmail аккаунт.

В поле Body вводим текст сообщения, которое будет отправляться покупателю. За место номера заказа и суммы заказа выбираем поля Name и Sum из предложенного списка. В поле Subject заполняем заголовок письма "Спасибо за покупку".

Спасибо за ваш заказ №{{100459341__name}} на сумму {{100459341__sum}} руб.

На следующем этапе Send Data жмем кнопку TEST & CONTINUE и затем TERN ON ZAP.

На указанный email покупателя поступит сообщение с данными заказа.

Модуль доступен для версии PHPShop 6.0.9+ и только для редакции PHPShop Pro.