Brevo Events API

Перед тим, як налаштувати відстеження активності на вашому сайті Odoo, спочатку отримайте ідентифікатор клієнта та ключ API для серверної інтеграції.

Ідентифікатор клієнта

Модуль інтегрує Brevo Tracker у веб-сайт Odoo за допомогою ідентифікатора клієнта (client_key). Для його отримання:

• 01
  Авторизуйтесь у своєму обліковому записі Brevo.com
• 02
  Перейдіть в меню Settings — Automations та відкрийте Brevo Tracker

• 03
  Оберіть опцію встановлення JS Tracker

• 04
  Скопіюйте значення параметра client_key на другому кроці

Ключ API

Щоб отримати ключ API, який є токеном доступу для серверної інтеграції з Odoo:

• 01
  Авторизуйтесь у своєму обліковому записі Brevo.com
• 02
  Перейдіть в меню Settings — SMTP and API та на вкладці API keys and MCP натисніть Generate API key

• 03
  Введіть назву ключа; оберіть термін дії; виберіть опцію Full, щоб надати повний доступ та натисніть Generate

• 04
  Скопіюйте та збережіть значення API key

Після встановлення модуля перейдіть до налаштувань веб-сайту та в розділі Enhanced Website Tracking увімкніть опцію Activate Tracking. Щоб перевірити відстеження веб-сайту та переглянути події відстеження в консолі браузера, також тимчасово активуйте функцію Debug Logging.

Модуль дозволяє відстежувати події електронної комерції на вашому сайті за допомогою сервісу відстеження. Він надсилає події відстеження в Brevo разом із інформацією про товари і наданими користувачами даними. Дані ви можете надсилати через Brevo Tracker та Events API. Додайте та налаштуйте сервіс відстеження для вашого веб-сайту Odoo.

Додавання сервісу відстеження

Перейдіть до меню Website – Configuration – Tracking – Services та натисніть New, щоб додати новий сервіс відстеження подій для вашого веб-сайту Odoo.

Спочатку заповніть наступні поля:

• Вкажіть Website (якщо використовуєте кілька веб-сайтів)
• Виберіть тип сервісу Brevo Tracker у полі Type
• Вставте скопійований client_key в поле Key

Потім вкажіть тип ідентифікатора для товарів та категорію товарів, які надсилати до Brevo.

Якщо товари мають характеристики та варіанти, виберіть Product Variant ID у полі Item Type, якщо ні — виберіть Product Template ID.

Оберіть бажаний тип категорії (Category Type): публічну категорію електронної комерції (Public Category) або внутрішню категорію товарів (Product Category).

Активація API подій

Активація Brevo Events API потребує токена доступу та логування подій.

Збереження подій відстеження у внутрішніх журналах Odoo є обов’язковим для серверної інтеграції.

Увімкніть опцію Internal Logs на вкладці Options.

Після цього активуйте серверну інтеграцію в розділі API — увімкніть опцію Activate та вставте згенерований API Key в поле Access Token.

Як згенерувати ключ API, дивіться в розділі Отримання ключів.

Ідентифікація контактів

Розширене зіставлення дозволяє визначити контактні дані відвідувачів веб-сайту та надати Brevo цю інформацію для SMS- та email-розсилок і інших автоматизацій. Відкрийте вкладку Advanced Matching та зазначте, яку саме інформацію має надсилати сервіс відстеження. Кнопка Enable Allowed дозволяє увімкнути всі доступні опції для цього сервісу відстеження.

Увімкнена галочка Hashed навпроти опцій Customer Name та Phone означає, що ця інформація про клієнтів захищена хешуванням відповідно до вимог Brevo.

Джерело даних клієнтів

Використовуйте значення Sale Order Partner для джерела даних клієнта, оскільки воно надає більше інформації про користувача у випадку, якщо відвідувачам сайту дозволяється здійснювати покупки без реєстрації.

Сервіс відстеження надсилає події з внутрішнього журналу через Brevo Events API із заданим інтервалом.

Щоб переглянути внутрішні події відстеження, перейдіть до меню Website – Configuration – Tracking – Logs або натисніть кнопку Logs у верхній частині форми сервісу відстеження.

Увімкніть колонки State та API Sent Date, щоб відобразити статус та дату відправлення події до Brevo через Events API.

Автоматична відправка подій

Модуль автоматично надсилає події відстеження за допомогою запланованої дії Odoo. За замовчуванням вона виконує відправку кожні 30 хвилин, і цей інтервал можна налаштувати відповідно до ваших вимог.

Список запланованих дій знаходиться в меню Налаштування — Технічні налаштування — Автоматизація — Заплановані дії та доступний тільки в режимі розробника.

Ручна відправка подій

Щоб надіслати дані відстеження вручну, виберіть записи журналу подій відстеження зі списку або відкрийте одну подію і натисніть Send Event.

Рішення містить додаткові налаштування, які доступні в режимі розробника.

Ідентифікатор товару

Модуль використовує поле Product ID як унікальний ідентифікатор товару. Якщо потрібно використовувати інше значення, то на вкладці Technical вкажіть інше поле товару, яке містить бажаний ідентифікатор:

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

Покупка на порталі

Для відстеження покупок на порталі увімкніть опцію Track Purchase on Portal:

Виключити доставку

Наступним параметром, доступним для сервісів відстеження, є Exclude Delivery. Коли ця опція увімкнена, рядки доставки з замовлень на продаж не включаються до даних відстеження і не надсилаються через сервіс:

Виключити винагороди

Щоб виключити рядки замовлення з винагородою з даних відстеження увімкніть опцію Exclude Reward:

Додавання в кошик

За замовчуванням відстежується фактичне додавання товару до кошика. Якщо бажано відстежувати подію під час натискання кнопки, не чекаючи фактичного додавання товару до кошика, то виконайте такі дії:

• Перейдіть до меню Веб-сайт — Налаштування — Веб-сайти
• Відкрийте сайт на вкладці Enhanced Tracking
• Увімкніть опцію Add to Cart on Click

Відстеження фактичного додавання може не працювати, якщо логіку було змінено сторонніми модулями. У цьому випадку ця опція дозволяє відстежувати подію, прив'язавши її до селекторів кнопок, що використовуються у стандартних шаблонах веб-сайтів Odoo.

Покупка

Для відстеження покупки лише після успішної платіжної операції, увімкніть опцію Track Confirmed Purchases only:

Опція впливає лише на відправку події через сервіс відстеження, внутрішній лог фіксується в будь-якому випадку.

Якщо за вашою бізнес-логікою покупкою можна вважати замовлення зі статусом оплати В очікуванні, то увімкніть також опцію Track Pending Purchases too.

Модуль надає можливість відключити JS-скрипт, щоб перевірити відправку подій через серверну інтеграцію Brevo Events API. Для цього виконайте наведені нижче дії.

Спочатку відкрийте ваш сервіс відстеження Brevo Tracker в Odoo на вкладці Options та увімкніть опцію Remove JS Script, щоб запобігти надсиланню подій до Brevo через JS-скрипт перед запуском API подій.

Тепер виконайте кілька дій на вашому сайті, наприклад, відкрийте список товарів або додайте товар у кошик.

Для тестування вийдіть з Odoo або використовуйте інший браузер, оскільки відстеження подій на веб-сайтах не працює для внутрішніх користувачів Odoo.

Після цього перейдіть до списку логів та відправте ці події вручну. Якщо статус — Warning або Error, перегляньте значення API Response на вкладці Technical, щоб отримати детальну інформацію.

Brevo дозволяє виконувати запити до API лише з авторизованих IP-адрес. Перевірте авторизовані IP-адреси в налаштуваннях безпеки вашого акаунту Brevo.com.

Статус Sent означає, що подія успішно відправлена через API.