Документация модуля CM Ocean Loyalty

CM Ocean Loyalty — модуль управления программой лояльности платформы CM Ocean (вендор — Data Sapience). Модуль ведёт балльную программу на основе двойной бухгалтерии (леджера), рассчитывает и применяет акции в реальном времени и предоставляет единое окно оператора в составе Core UI.

Здесь собрана техническая и пользовательская документация по модулю: описание функций, интерфейсов, ролевой модели и интеграций.

Документация структурирована по разделам:

• Руководство пользователя — интерфейсы и сценарии: акции, клиенты и карточка клиента, баланс и баллы, конфигурации программы, справочники и настройки, мониторинг и отчёты.
• Руководство администратора — архитектура, установка, конфигурация, ролевая модель, интеграции и наблюдаемость.
• API Reference — спецификация REST API (OpenAPI), примеры запросов и ответов.
• Release Notes — история изменений и ключевые возможности версий.

Используйте меню слева, чтобы перейти к нужному разделу.

Ключевые возможности

• Балльный леджер — учёт баллов на двойной бухгалтерии: субсчета, начисление, списание (двухфазное hold/commit), перевод, обмен, срок жизни баллов по цепочке и сгорание по срокам с предупреждениями клиенту. Все денежные операции идемпотентны.
• Акции — каталог механик (кэшбэк, множитель, подарок, реферальная, начисление за единицу), форма акции с условиями из реестра условий («Настройка акции»), метки акций, ограничения и лимиты, согласование запуска, автоведение по периоду, арбитраж и версионирование, статистика применения.
• Конфигурации программы — уровни, акции программы и уровней, правила списания и активация новой редакции правил; уровень клиента считается по журналу покупок и пересматривается в личную дату.
• Клиенты и вовлечённость — каталог клиентов, карточка клиента по настраиваемой схеме, теги клиента, сегменты из системы кампаний, ручные операции с баллами и тегами, реферальная программа, достижения и бейджи, карта в мобильном кошельке, личный кабинет клиента (B2C).
• Справочники (НСИ) — локальные операционные справочники и собственные справочники продукта (города, торговые точки, мерчанты, каталог товаров, сегменты), справочник валют программы и пары обмена, жизненный цикл и аудит изменений, перенос между контурами.
• Отчёты и мониторинг — сводные отчёты за период (обзор, баллы, уровни, акции с выгрузкой таблицы в CSV, рефералы), мониторинг операций и аномалий с произвольным периодом.
• Интеграции — приём событий покупок и возвратов (POS), приём начислений от модуля Promo и RT Flow, проверка условий для RT Flow, приём сегментов из системы кампаний, исходящие события (смена уровня, уведомления клиентам), проекция клиента для Check Scan, профиль клиента через MDM, асинхронный приём команд через очередь (опционально Kafka), обмен данными с внешними системами.
• Безопасность и наблюдаемость — аутентификация через Keycloak (OAuth2), ролевая модель LOYALTY_*, журнал аудита с защитой от подделки и передачей в SIEM, структурные логи, метрики Prometheus, health-пробы.

Положение в контуре

CM Ocean Loyalty встраивается в единое окно Core UI как микрофронтенд и взаимодействует с соседними модулями платформы — Promo (кампании и коммуникации), MDM (мастер-данные), RT-Flow/SDE (потоковые правила), DWH (витрины и аналитика).

Платформа CM Ocean: https://datasapience.ru/platforms/cmocean