Сутність «Програма Рекомендацій» в системі inCust
Підсистема Програми лояльності Бренду, що винагороджує Роздрібних Покупців за залучення нових покупців через персональні рекомендації Точок продажу.
Сутність «Програма Рекомендацій» в системі inCust
Синоніми: Реферальна програма, Referral program.
Що це таке
Програма Рекомендацій — підсистема Програми лояльності Бізнесу, що винагороджує Роздрібних Покупців за залучення нових покупців через персональні рекомендації Точок продажу Бізнесу.
Програма Рекомендацій не є самостійною сутністю верхнього рівня — вона завжди є частиною конкретної Програми лояльності й ідентифікується через loyalty_id своєї Програми лояльності.
Учасники процесу
- Порадник (referrer, рекомендавець) — існуючий Роздрібний Покупець, який передає рекомендацію.
- Друг (referral, отримувач рекомендації) — особа, якій передано рекомендацію; може бути існуючим Роздрібним Покупцем або новим, що реєструється через прийняття запрошення.
Канал рекомендації
Рекомендація передається через мобільний додаток inCust: Порадник на сторінці конкретної Точки продажу натискає «Рекомендувати», обирає друга та спосіб передачі. Друг приймає рекомендацію в мобільному додатку або через веб-кабінет на my.incust.com.
Передумова для роботи функціоналу: у Бізнесу мають бути опубліковані Точки продажу в мобільному каталозі, а Порадник має встановлений мобільний додаток inCust.
Конфігурація програми
Налаштовується в кабінеті Бізнесу в розділі «Програми лояльності → Програма рекомендацій». Поля:
- Активність — прапорець вмикання програми.
- Назва і опис — задається окремо кожною підтримуваною мовою; мобільний додаток показує покупцю текст мовою, встановленою в телефоні (або обраною в додатку).
- Хто може рекомендувати — або всі учасники Програми лояльності, або тільки покупці, що здійснювали покупки.
- Хто може використовувати рекомендацію — або будь-хто, або обмежено тими, хто ще не купував / не зареєстрований учасником програми.
- Тип винагороди за прийняття рекомендації (винагорода Другу) — один з варіантів: відсутня, бонуси, акційні бонуси (з терміном придатності), сума на спеціальний Рахунок покупця (попередньо створений у b.incust.com/client-accounts) або Купон (попередньо створений як Серія в b.incust.com/series).
- Винагорода Порадника — конфігурується схема нарахування:
- База обчислення: за кожен чек Друга, за сумарну кількість перших чеків, або за чеки за певний період.
- Тип значення: фіксована кількість бонусів, або відсоток від суми чека Друга.
- Багаторівнева схема: окремі ставки на різних рівнях глибини рекомендацій (наприклад, 5% з чеків прямого друга, 3% з чеків друга цього друга).
- Лого Порадника і Друга — окремі зображення (
image/jpegабоimage/png), що показуються в мобільному додатку відповідній стороні процесу.
Зв'язки з іншими сутностями платформи
- Бізнес / Бренд — власник програми; конфігурація задається в межах налаштувань Програм лояльності Бізнесу.
- Програма лояльності — Програма Рекомендацій є підсистемою конкретної Програми лояльності, ідентифікується через
loyalty_id. - Точка продажу — об'єкт, що рекомендується; має бути опублікованою в мобільному каталозі.
- Роздрібний Покупець — і Порадник, і Друг є Роздрібними Покупцями (Друг стає ним після прийняття рекомендації, якщо не був раніше).
- Рахунок покупця — можливий тип винагороди.
- Купон / Серія купонів — можливий тип винагороди.
- Бонусний рахунок Покупця — приймальник бонусів і акційних бонусів.
Відображення в API
Функціонал доступний через Business API, Client API та Terminal API.
Business API
Адміністрування програми з кабінету Бізнесу — конфігурація, ідентифікаційні матеріали, публічна інформація за кодом.
Конфігурація Програми лояльності loyalty_id:
| Метод | Шлях | Призначення |
|---|---|---|
GET | /loyalty/{loyalty_id}/referral_program | Прочитати конфігурацію Програми Рекомендацій |
PATCH | /loyalty/{loyalty_id}/referral_program | Змінити конфігурацію (активність, опис, обмеження «хто рекомендує / хто приймає», тип і розмір винагород, багаторівнева схема) |
Лого, що показуються Поряднику і Другу в мобільному додатку:
| Метод | Шлях | Призначення |
|---|---|---|
POST | /loyalty/{loyalty_id}/referral_program/referral_logo | Завантажити лого для Друга |
DELETE | /loyalty/{loyalty_id}/referral_program/referral_logo | Видалити лого для Друга |
POST | /loyalty/{loyalty_id}/referral_program/referrer_logo | Завантажити лого для Порадника |
DELETE | /loyalty/{loyalty_id}/referral_program/referrer_logo | Видалити лого для Порадника |
Публічна інформація за кодом запрошення (без контексту loyalty_id):
| Метод | Шлях | Призначення |
|---|---|---|
GET | /business/check_referral/{code} | Перевірити існування реферального коду |
GET | /loyalty/referral_program/info/{code} | Інформація про Програму Рекомендацій за кодом (JSON) |
GET | /loyalty/referral_program/info/{code}/html | Те саме у вигляді відрендереного HTML; параметр lang задає мову |
Канонічна специфікація: Swagger Business API (KNOW-006).
Client API
Кабінет Роздрібного Покупця — мобільний додаток, my.incust.com. Запити виконуються в контексті авторизованого Покупця-учасника Програми лояльності loyalty_id.
Дії Порадника:
| Метод | Шлях | Призначення |
|---|---|---|
GET | /loyalty/{loyalty_id}/referral_program/code | Згенерувати і повернути персональний код Порадника — те, що передається Другу |
GET | /loyalty/{loyalty_id}/referral_program/summary | Зведена статистика участі Покупця: кількість запрошень, прийнятих рекомендацій, нарахованих винагород |
GET | /loyalty/{loyalty_id}/referral_program/chain | Реферальний ланцюжок цього Покупця (для багаторівневих схем); прапорець rewards додає нараховані винагороди |
GET | /loyalty/{loyalty_id}/referral_program/referrer | Інформація про Порадника цього Покупця, якщо він сам прийшов за чужою рекомендацією |
Дії Друга — приймання запрошення:
| Метод | Шлях | Призначення |
|---|---|---|
GET | /loyalty/referral_program/invitation/{code} | Інформація про запрошення за кодом (хто запросив, яку винагороду отримає Друг, умови) |
POST | /loyalty/referral_program/invitation/{code} | Прийняти або відхилити запрошення; на прийнятті встановлюється зв'язок Порадник↔Друг і нараховується винагорода Друга |
Канонічна специфікація: Swagger Client API (KNOW-008).
Terminal API
inCust Термінал і Кіоск. Працює від імені робітника на Точці продажу, тому Покупця ідентифікують явно через параметри user_id_value + user_id_type (телефон, email, картка тощо). Контекст Бізнесу і Точки продажу задається авторизацією Терміналу; loyalty_id у URL не передається.
| Метод | Шлях | Призначення |
|---|---|---|
GET | /referral_program/code | Згенерувати і видати реферальний код для зазначеного Покупця — продавець може видати клієнту його код прямо біля каси |
GET | /referral_program/summary | Зведена статистика участі Покупця в Програмі Рекомендацій |
GET | /referral_program/chain | Реферальний ланцюжок Покупця; з rewards — разом з нарахованими винагородами |
GET | /referral_program/referrer | Хто є Порадником цього Покупця |
Канонічна специфікація: Swagger Terminal API (KNOW-009).
Розподіл відповідальності за ролями
- Business API — адмін конфігурує програму (правила, винагороди, лого) та звіряє коди.
- Client API — Покупець у мобільному додатку: емітує свій код, бачить свій ланцюг і статистику, приймає запрошення Друга.
- Terminal API — Робітник на касі виконує ті самі операції, що Покупець у додатку, але від імені вказаного Покупця (без авторизації самого Покупця).
Джерела
- Розділ 2.2.5 «Програма рекомендацій» офіційного посібника Бізнес-кабінету inCust: incust.com/ua/knowledgebase/.../loyalties-rec/
- API-специфікації: Swagger Business API (
KNOW-006), Swagger Client API (KNOW-008), Swagger Terminal API (KNOW-009).
Сутність «Точка продажу» в системі inCust
Операційний актив Бренду — оболонка для групи Терміналів і одиниця організації роздрібних продажів, доставки та онлайн-замовлень
Сутність «Серія Купонів» в системі inCust
Самостійна сутність Бренду — шаблон-генератор однотипних Купонів зі спільними правилами випуску, видачі та погашення, включно з купонами-промокодами на зовнішніх кодах