Содержание

Автоматическое оповещение сторонних скриптов и сервисов (вебхуки, webhooks)

АвтоВебОфис позволяет автоматически отправлять оповещения о счетах, заявках, контактах, подписках на указанные URL сторонних скриптов и сервисов.

Если API работает по системе запроса пользователя, т.е. инициатором выступаете Вы, то, когда Вы заполняете «URL оповещения», инициатором запроса уже выступаем мы, и как только наступает выбранное событие, например, счет оплачен, шлем POST-запрос, внутри которого содержится сериализованный массив с данными о счете по указанному URL на Вашу страницу со скриптом (который напишет Ваш тех специалист), который будет обрабатывать полученный массив данных.

Переменные можно передавать как GET-параметры. Например: test.ru/webhook.php?email={email}&name={name}

URL для оповещений указывается в разделе Настройки-Оповещение скриптов

Для настройки данного функционала:

  1. Войдите в раздел Настройки зарегистрированного в сервисе АвтоВебОфис аккаунта
  2. В левом боковом меню выберите пункт Настройки→ Вебхуки
  3. В поле «URL для отправки оповещений» нужного блока укажите адрес, на который должны будут отправляться оповещение
  4. Напротив указанной ссылки поставьте галочку
Image

После этого, в случае наступления выбранного события, на указанный Вами «URL для отправки оповещений» будут отправлены методом $_POST следующие данные:

Контакты

По контактам есть 3 типа действий, по которым можно задать отправку уведомлений: создание контакта, изменения в карточке контакта, удаление контакта.

Параметр Описание
id_contact Код контакта
last_name Фамилия
name Имя
middle_name Отчество
email Ящик
password Пароль от личного кабинета
id_partner Код партнера
not_to_write Стоит галочка «Не писать»
spam_clicked Стоит галочка «Жалоба на СПАМ»
spam_clicked_date Дата жалобы на СПАМ
unsubscribe_date Дата отписки
email_not_exist Ящик не существует
phone_number Номер телефона
do_not_call Стоит галочка «Не звонить»
id_country Код страны
zip_code Индекс
area Область
city Город
delivery_address Адрес доставки
skype Скайп
ban Стоит голчка «Бан»
ban_reason Причина попадания в бан
sex Пол
date_of_birth Дата рождения
brief_description Описание
date_registration Дата регистрации
id_employee_responsible Код ответственного сотрудника
id_employee_created Код сотрудника, зарегистрировавшего контакт
id_advertising_channel_page API код канала рекламы
advertising_channel_keyword ключевое слово
advertising_channel_location место размещения
advertising_channel_type_traffic тип трафика
deleted Карточка контакта была удалена
deleted_date Дата удаления контакта
vk_user Идентификатор вКонтакте
fb_user Идентификатор Facebook
datetime_notify Дата отправки уведомления
telegram_user_id id телеграм контакта
telegram_user Имя пользователя телеграм

Пример запроса на изменение контакта: 

Array
(
[0] => Array
      (
          [id_contact] => 20076
          [last_name] => 
          [name] => 
          [middle_name] => 
          [email] => alimera.70@mail.ru
          [password] => 455bfa3
          [id_partner] => 0
          [not_to_write] => 0
          [spam_clicked] => 0
          [spam_clicked_date] => 0000-00-00 00:00:00
          [unsubscribe_date] => 0000-00-00 00:00:00
          [email_not_exist] => 0
          [phone_number] => 
          [do_not_call] => 0
          [id_country] => 0
          [zip_code] => 
          [area] => 
          [city] => 
          [delivery_address] => 
          [skype] => 
          [ban] => 0
          [ban_reason] => 
          [sex] => 0
          [date_of_birth] => 0000-00-00
          [brief_description] => 
          [date_registration] => 2021-03-15 14:28:08
          [id_employee_responsible] => 0
          [id_employee_created] => 0
          [deleted] => 0
          [deleted_date] => 0000-00-00 00:00:00
          [vk_user] => 
          [fb_user] => 
          [analytics_cookies] => {"_ga":"GA1.2.1923020967.1571907459","_ym_uid":"1556297658664120224"}
          [roistat] => 
          [vk_user_id] => 
      )
  [1] => Array
      (
          [id_contact] => 20075
          [last_name] => 
          [name] => 
          [middle_name] => 
          [email] => fvioletta@mail.ru
          [password] => c30c926
          [id_partner] => 0
          [not_to_write] => 0
          [spam_clicked] => 0
          [spam_clicked_date] => 0000-00-00 00:00:00
          [unsubscribe_date] => 0000-00-00 00:00:00
          [email_not_exist] => 0
          [phone_number] => 
          [do_not_call] => 0
          [id_country] => 0
          [zip_code] => 
          [area] => 
          [city] => 
          [delivery_address] => 
          [skype] => 
          [ban] => 0
          [ban_reason] => 
          [sex] => 0
          [date_of_birth] => 0000-00-00
          [brief_description] => 
          [date_registration] => 2021-03-15 14:28:07
          [id_employee_responsible] => 0
          [id_employee_created] => 0
          [deleted] => 0
          [deleted_date] => 0000-00-00 00:00:00
          [vk_user] => 
          [fb_user] => 
          [analytics_cookies] => {"_ga":"GA1.2.1923020967.1571907459","_ym_uid":"1556297658664120224"}
          [roistat] => 
          [vk_user_id] => 
      )
 )

Счета

По счетам есть 2 типа действий, по которым можно задать отправку уведомлений: создание счета, изменения в счете (например, смена статуса счета на оплачен)

Параметр Описание
id_account Код счета
account_number Номер счета
account_sum Общая сумма счета
id_account_status код статуса счета (1 - создан, 2 - отказ, 3 - в обработке, 4 - ошибка, 5 - оплачен)
close_account признак закрытия счета
id_partner Код партнера
id_payment_system Код платежной системы
close_date дата закрытия счета
date_of_order дата создания счета
goods_return признак возврата товара
date_of_payment Дата оплаты счета
goods_return_date Дата возврата товара
last_name фамилия
name имя
middle_name отчество
email ящик
phone_number телефон
skype скайп
account_comment комментарий к счету
id_organization код организации
id_delivery_region код региона доставки
area область
city город
delivery_address адрес доставки
zip_code почтовый индекс
barcode почтовый идентификатор
id_delivery_region_method код способа доставки для региона
id_advertising_channel_page API код канала рекламы
advertising_channel_keyword ключевое слово
advertising_channel_location место размещения
advertising_channel_type_traffic тип трафика
deleted счет удален
vk_user идентификатор вКонтакте
fb_user идентификатор Facebook
id_account_line код строки счета
id_goods код товара
goods название товара на момент заказа
price цена
quantity количество
sum_price сумма строки счета
vendor_code код поставщика
add_fields дополнительные поля к заказу
name название дополнительного поля к товару
value комментарий, оставленный покупателем в дополнительном поле
link_for_pay ссылка на выбор способа оплаты
datetime_notify дата отправки уведомления

Пример запроса о создании счета 

Array
  (
  [id_account] => 370211
  [account_number] => 289
  [account_sum] => 500
  [id_account_status] => 1
  [close_account] => 0
  [id_partner] => 1
  [id_payment_system] => 0
  [close_date] => 0000-00-00 00:00:00
  [date_of_order] => 2019-02-21 15:29:46
  [goods_return] => 0
  [date_of_payment] => 0000-00-00 00:00:00
  [goods_return_date] => 0000-00-00 00:00:00
  [last_name] => 
  [name] => 
  [middle_name] => 
  [email] => a@gmail.com
  [phone_number] => 
  [skype] => 
  [account_comment] => 
  [id_organization] => 0
  [id_delivery_region] => 0
  [area] => 
  [city] => 
  [delivery_address] => 
  [zip_code] => 
  [barcode] => 
  [id_delivery_region_method] => 0
  [id_advertising_channel_page] => 0
  [advertising_channel_keyword] => 
  [advertising_channel_location] => 
  [advertising_channel_type_traffic] => 
  [id_contact] => 3
  [deleted] => 0
  [vk_user] => 
  [fb_user] => 
  [lines] => Array
(
          [321] => Array
              (
                  [id_account_line] => 321
                  [id_goods] => 1
                  [goods] => Вязаная игрушка "Котейка"
                  [price] => 500.00
                  [quantity] => 1
                  [sum_price] => 500.00
                  [vendor_code] => 
                  [add_fields] => Array
                      (
                          [0] => Array
                              (
                                  [name] => пожелание
                                  [value] => хочу желтую котейку
                              )
                      )
              )
      )
  [link_for_pay] => https://mila.autoweboffice.ru/?r=ordering/cart/s2&id=370211&vc=1533628675&lg=ru
  [datetime_notify] => 2019-02-21 15:29:46
  )

Пример запроса, который приходит от АвтоВебОфис, при настройке вебхуков в товаре

Настроить можно в разделе «Продажи → Товары → в редактировании товара на вкладке Дополнительно»

Важно! Истории запросов при настройке в товаре система не хранит

Image 
(
  [id_account] => 113390
  [account_number] => 112216
  [date_of_order] => 2020-12-22 13:56:17
  [date_of_payment] => 2020-12-22 13:56:19
  [id_payment_system] => 0
  [id_account_status] => 5
  [id_contact] => 17103
  [email] => earthmanmail@ya.ru
  [phone_number] => 79035900000
  [last_name] => 
  [name] => Человек на земле
  [middle_name] => 
  [id_country] => 0
  [area] => 
  [city] => 
  [delivery_address] => 
  [skype] => 
  [zip_code] => 
  [id_account_line] => 170408
  [id_goods] => 52
  [goods] => Название товара
  [price] => 0.00
  [quantity] => 1
  [sum_price] => 0.00
  [vendor_code] => 
  [vk_user] => 
  [vk_user_id] => 
  [fb_user] => 
  [hash] => 68076b61409efa3f99b35f5cb7c931e7
  )

Подписка

По подписке есть 2 типа действий, по которым можно задать отправку уведомлений: создание подписки, подтверждение подписки

Параметр Описание
id_contact код контакта
id_newsletter код группы подписчиков
subscribed_date дата подписки
confirmed
unsubscribed отписался (0-нет, 1-да)
email ящик
newsletter название группы подписчиков
datetime_notify дата отправки уведомления
field_1 Дополнительное поле 1
field_2 Дополнительное поле 2
field_3 Дополнительное поле 3

Пример запроса о подписке 

 Array
(
[0] => Array
      (
          [id_contact] => 19927
          [email] => upucc@mail.ru
          [id_newsletter] => 15
          [newsletter] => Группа для тестирования импорта
          [id_partner] => 0
          [subscribed_date] => 2021-03-15 12:00:16
          [confirmed] => 1
          [confirmed_date] => 2021-03-15 12:00:16
          [unsubscribed] => 0
      )
[1] => Array
      (
          [id_contact] => 19928
          [email] => n4talishu@yandex.ru
          [id_newsletter] => 15
          [newsletter] => Группа для тестирования импорта
          [id_partner] => 0
          [subscribed_date] => 2021-03-15 12:00:16
          [confirmed] => 1
          [confirmed_date] => 2021-03-15 12:00:16
          [unsubscribed] => 0
      )
)

Проверка запросов

Внизу на странице настройки оповещений сторонних скриптов раздел «Список последних запросов». Там Вы можете посмотреть все запросы, которые были отправлены на Ваш сервер.

Image

Вы можете зайти в каждый запрос и посмотреть весь отправленный массив, статус отправки (успешно или ошибка) и приема его Вашим сервером и ответ от Вашего сервера

Если у Вас еще остались какие-либо вопросы, пожалуйста, обращайтесь в нашу Службу поддержки по email zakaz@autoweboffice.com или в окне консультанта на сайте http://autoweboffice.com