Javascript SDK

Общее описание

JavaScript SDK позволяет асинхронно взаимодействовать сайту с платформой Mindbox. Он интегрируется аналогично Google Analytics или Яндекс.Метрике, при этом не влияя на скорость загрузки сайта и работу трекеров.

Для работы с JavaScript SDK используется один объект "mindbox". Для вызова метода используется следующая конструкция: mindbox('methodName', methodParameters, ... )

methodParameters - объект с параметрами для метода. Набор параметров зависит от метода. С помощью данной конструкции можно вызывать методы в любом месте страницы после кода отслеживания. Если код JavaScript SDK еще не загружен, операции встанут в очередь и выполнятся, как только произойдет полная инициализация скрипта.

Так как JavaScript SDK может использовать различные поддомены на домене mindbox.ru, настройки сайта должны позволять использование кросс-доменных запросов (подробней можно прочитать здесь). Количество поддоменов и ip-адреса доменов не фиксируются, поэтому следует включать все поддомены в Content Security Policy директиву.

Инициализация

Code
  <script>
      mindbox = window.mindbox || function() { mindbox.queue.push(arguments); };
      mindbox.queue = mindbox.queue || [];
      mindbox('create', {
          endpointId: '<Идентификатор точки интеграции>'
      });
  </script>
  <script src="https://<Domain API Mindbox>/scripts/v1/tracker.js" async></script>

Код отслеживания должен подключаться в самом верху страницы, до остальных вызовов JavaScript SDK.
Чтобы точка интеграции определялась по домену, необходимо добавить этот домен в ее настройках.

Получение deviceUUID

Метод позволяет получить уникальный идентификатор устройства (deviceUUID), который используется Mindbox для идентификации пользователей, и использовать его для вызова. Например, для интеграции с системами аналитики или для передачи на backend вашего сайта.

Code
mindbox("helpers.getDeviceUUID", value => {
  // Ваш код для работы с deviceUUID
  })

Вызов операций

Code
mindbox('async', {
operation: '<Название операции>',
data: <Данные для операции>,
onSuccess: <Функция, вызываемая при успехе>,
onError: <Функция, вызываемая при ошибке>
});

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

Примеры

Code
mindbox('async', {
  operation: 'MySite.Registration',
  data: {
    customer: {
      mobilePhone: '79374134389',
      firstName: 'Иван',
      email: 'pivan@mindbox.ru'
    }
  },
  onSuccess: function() {
    alert("Вы успешно зарегистрированы.");
  },
  onError: function(error) {
    console.log(error);
  }
});

Для корректной работы форм персонализации сайта следует:

• Перед трекером Mindbox добавить тег

Code
  <script> 
    window.PopMechanic = {watchLocation: false}; 
  </script>

• После смены страницы вызывать в JS

Code
  window.PopMechanic && window.PopMechanic.update && window.PopMechanic.update()

Возможные ошибки