Модуль OSMI Cards (Wallet) для RetailCRM

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

1. Войдите под своей учетной записью в RetailCRM с правами администратора.

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

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

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

5. Отметьте магазин из списка, с которым будет работать модуль.

6. Отметьте методы из списка Разрешенные методы API. (Нужные методы указаны в Приложении 1).

7. Скопируйте ключ, он понадобится в следующем пункте настроек.

8. Нажмите «Сохранить».

Не рекомендуется использовать уже существующий API-ключ. Для каждой интеграции создавайте новый API-ключ.

1. Перейдите в Настройки/Интеграции/Маркетплейс.

2. Выберите модуль.

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

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

1. Вводим ссылку на RetailCRM.

2. Вставляем скопированный ранее API-ключ и ссылку на RetailCRM.

3. Для заполнения поля Адрес доступа вам нужно открыть письмо, в котором присылались доступы от OSMI Cards, и найти там ссылку вида https://api10.osmicards.com и после выберите идентичное значение из выпадающего списка.

Важно! Обращайте внимание на цифры в ссылке после api!

OSMI Card API ID — также берём из письма с доступами.

OSMI Card API KEY — также берём из письма с доступами.

4. Нажимаем «Сохранить».

Магазин создаваемых клиентов — выбираем магазин, в котором будут создаться клиенты, убедитесь, что к нему подключена программа лояльности.

WEB Хук — используем для подключения к OSMI. (подробнее в следующем пункте Настройка на стороне OSMI Cards).

Проверка существования клиента — вебхук для поиска клиента по номеру телефона. Встраивается в триггер. Пример триггера на скриншоте ниже.

Кампания OSMI, автоматически генерирующая номер карты.

Пользовательское поле программы лояльности, для активации ссылки (Если выбрана кампания).

Добавить нового клиента в активную программу лояльности — Позволяет включить или отключить функционал.

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

1. Копируем WEB Хук из прошлого пункта.

2. Заходим в ЛК OSMI Cards: Интеграция/Веб-хуки.

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

4. Заполняем поля:

• Тип — User completed registration.
• Метод — GET.
• URL — скопированный WEB Хук.
• Порт — оставляем пустым.
• Заполняем логин и пароль.

5. Нажимаем Сохранить.

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

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

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

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

• Должен быть шаблон карты.
• Этот шаблон связывают в модуле с программой лояльности.
• Создается поле в шаблоне, в вашем случае — количество баллов.
• В модуле указывается что в этом шаблоне, в это поле передавать количество баллов.

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

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

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

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