retailCRM

Описание

Данная инструкция поможет вам настроить отправку клиентов из retailCRM в InSkill с выдачей доступа в личный кабинет.

Отправка данных может происходить при определенных условиях: смена статуса заказа, изменение статуса оплаты и др.

Как это работает

Интеграция работает на основе следующих функций:

• Триггеры retailCRM (подробнее в документации)

• API InSkill (документация по API)

Схема работы

1. При смене статуса заказа (или другом условии) происходит срабатывание триггера.

2. Триггер отправляет HTTP-запрос в сторону API InSkill.

3. Запрос содержит контактные данные клиента (email, телефон, ФИО). Также в запросе может быть указан ID продукта, который нужно выдать клиенту.

4. Происходит выдача доступа клиенту (генерация пароля и отправка приветственного письма на email клиента).

Что нужно для настройки

• У вас должен быть доступ в retailCRM (в раздел "Администрирование -> Коммуникации").

• У вас должен быть API-ключ InSkill (как получить ключ).

• Вы должны знать адрес своего проекта в InSkill, например: https://onegym.inskill.ru

Настройка

Создание триггера

1. Зайдите в свой аккаунт retailCRM.

2. Перейдите в раздел "Администрирование - Коммуникации - Триггеры":

Раздел "Триггеры"

3. Нажмите "Добавить +" для создания нового триггера:

4. Укажите название триггера, например "Выдача доступа в InSkill".

5. Выберите из списка подходящее событие, при котором будет срабатывать триггер:

Обязательно заполните название и выберите событие

6. Настройте фильтр (при необходимости). Фильтр нужен, если вы хотите применить триггер только к некоторым объектам.

Например, если триггер должен срабатывать только для заказов суммой больше 1 000 рублей, тогда фильтр будет выглядеть так:

order.getSumm() > 1000

Подробности ищите в синтаксисе и справочнике объектов.

7. Настройте условие применения триггера. Это поле необходимо заполнить, чтобы триггер срабатывал только для при определенных событиях: например, изменение статуса - переход в статус "Выполнен" (complete):

changeSet.hasChangedField("status") and 
changeSet.getNewValue("status").getCode() == "complete"

Примеры некоторых выражений можно посмотреть здесь.

8. Добавьте действие "Выполнить HTTP-запрос":

9. Заполните поле "Адрес" следующим образом:

https://ХХХХХХ.inskill.ru/api/v3/students

где ХХХХХХ - поддомен вашего проекта.

Внимательно проверьте адрес: он должен указывать на поддомен вашего проекта.

Пример адреса для проекта "onegym":

https://onegym.inskill.ru/api/v3/students

10. Укажите HTTP-заголовки для авторизации запросов.

Нажмите "Добавить заголовок", заполните поля:

• В поле "Заголовок" введите: Authorization

• В поле "Значение" введите: Bearer {token}, где {token} - ваш ключ от API InSkill. Обратите внимание: после слова Bearer обязательно должен быть пробел.

Вот что должно получиться

11. Выберите HTTP метод отправки запросов: POST.

12. Выберите способ передачи параметров запроса.

В поле "Передавать параметры" выберите: В строке запроса.

13. Добавьте параметры запроса.

Список доступных параметров:

Параметр	Обязательный	Описание
email	Да	Электронная почта клиента, на которую будет выдан доступ.
product	Нет	ID продукта из личного кабинета InSkill, который будет присвоен клиенту.
force	Нет	Определяет, присваивать ли продукт, если клиент уже есть в InSkill. Если force НЕ указан или равен 0, то продукт НЕ будет добавлен клиенту.
name	Нет	ФИО клиента.
phone	Нет	Телефон клиента.

Подробнее о доступных параметрах - см. документацию по API InSkill.

В поле "Значение" вы можете использовать шаблоны из справочника объектов retailCRM.

Пример заполнения:

Пример заполнения параметров запроса

14. Сохраните триггер.

Проверка триггера

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

Например, если условие применения вашего триггера - это смена статуса заказа на "Выполнен" то вы можете создать тестовый заказ, указав свой email в качестве почты клиента и вручную перевести этот заказ в статус "Выполнено". При этом, должен сработать триггер и в личном кабинете InSkill будет добавлен новый клиент.

Решение проблем

Журнал

Чтобы посмотреть результаты работы вашего триггера, воспользуйтесь разделом "Настройки -> Журнал" в панели retailCRM.

Если в журнале есть записи о срабатывании вашего триггера, но клиент не был добавлен в личный кабинет InSkill - напишите нам на [e-mail] и приложение ошибку из журнала триггеров.