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

Содержание

1. Создание Ключа доступа к API
2. Вход в настройки модуля
3. Настройка модуля
   — Вкладка «Доступ»
   — Вкладка «Основные
   — Настройка на стороне OSMI Cards
   — Вкладка «Уровни»
   — Вкладка «Шаблоны»

Перед тем как приступить к настройке интеграции запросите доступы у технической поддержи OSMI Cards:

«Добрый день, хотим работать через API, отправьте пожалуйста: Адрес доступа, OSMI Card API ID и OSMI Card API KEY.»

 1. Создание Ключа доступа к API

1. Войдите под своей учетной записью в RetailCRM с правами администратора.
2. Перейдите в Настройки/Интеграции/Ключи доступа к API.

3. Нажмите кнопку «Добавить».

4. Выберите тип доступа к магазину.

5. Отметьте магазин из списка, с которым будет работать модуль.
6. Отметьте методы из списка Разрешенные методы API. (Нужные методы указаны в Приложении 1).
7. Скопируйте ключ.
8.Нажмите “Сохранить”. 

2. Вход в настройки модуля

1. Перейдите в Настройки/Интеграции/Маркетплейс.
2.  Выберите модуль.

3. Нажмите кнопку «Перейти в личный кабинет». При первом входе откроется страница регистрации.

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

Вкладка «Доступ»

1. Вводим ссылку на RetailCRM
2. Вставляем скопированный ранее API-ключ и ссылку на RetailCRM
3. Для заполнения поля Адрес доступа вам нужно открыть письмо, в котором присылались доступы от OSMI Cards, и найти там ссылку вида https://api10.osmicards.com и после выберите идентичное значение из выпадающего списка.
   Обращайте внимание на цифры в ссылке после api!
4. OSMI Card API ID — берём из письма с доступами;
5. OSMI Card API KEY — берём из письма с доступами;
6. Нажимаем «Сохранить».

Вкладка «Основные»

1. Магазин создаваемых клиентов — выбираем магазин, в котором будут создаться клиенты, убедитесь, что к нему подключена программа лояльности.
2. WEB Хук — используем для подключения к OSMI. (подробнее в следующем пункте Настройка на стороне OSMI Cards)
3. Проверка существования клиента — вебхук для поиска клиента по номеру телефона. Встраивается в триггер. Пример триггера на скриншоте ниже
4. Кампания OSMI, автоматически генерирующая номер карты —
5. Пользовательское поле программы лояльности, для активации ссылки (Если выбрана кампания) —
6. Добавить нового клиента в активную программу лояльности — Позволяет включить или отключить функционал

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

Настройка на стороне OSMI Cards

1. Копируем WEB Хук из прошлого пункта;
2. Заходим в ЛК OSMI Cards: Интеграция/Веб-хуки;
3. Нажимаем «Добавить веб-хук»
4. Заполняем поля:
   1) Тип — User completed registration
   2) Метод — GET;
   3) URL — скопированный WEB Хук;
   4) Порт — оставляем пустым;
   5) Заполняем логин и пароль;
   6) Нажимаем Сохранить.

Вкладка «Шаблоны»

Если шаблоны карт заведены в OSMI Cards, то они подгрузятся в модуль автоматически.

Для работы в модуле с шаблонам достаточно сопоставить поля шаблона полями в карточке клиента.

Важно:
Если наблюдаются проблемы при передаче данных, проверьте, всё ли корректно настроено.

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

1) Должен быть шаблон карты

2) Этот шаблон связывают в модуле с программой лояльности

3) Создается поле в шаблоне, в вашем случае — количество баллов.

4) В модуле указывается что в этом шаблоне, в это поле передавать количество баллов

Все, можно проверять. Клиент регистрируется по ссылке-анкете. Приходить в CRM. Там начисляются баллы, их видит клиент в приложении

Вкладка «Уровни»

Шаблон по умолчанию — если у вас только 1 шаблон и нет уровней лояльности, проставьте шаблон OSMI в это поле.

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

Приложение 1

Необходимые методы API RetailCRM для работы модуля: