ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

Bonuses

Контроллер для работы с бонусами

API	Description
POST api/bonuses/OperatorBonus	Начисление или списание бонусов по карте/телефону/идентификатору участника программы лояльности
POST api/bonuses/BonusSourceInfo	Получение справочника возможных источников начисляемых бонусов в БД системы лояльности
POST api/bonuses/import	Массовый импорт бонусов из Excel
POST api/bonuses/GetBonusImportState	Получение состояние импорта бонусов из Excel
POST api/bonuses/EventBonusAdd	Ручное добавление событийного бонуса
POST api/bonuses/BurnActivePeriod	Получение информации о клиентах, у которых в заданный промежуток времени сгорят бонусы и/или активируются бонусы
POST api/bonuses/BonusMarketlistAction	Создание/обновление/получение информации по заданию для начисления бонусов на маркетинговый список клиентов или произвольный список карт/клиентов/телефонов
POST api/bonuses/BonusMarketlistPagingInfo	Получение информации о созданных заданиях на начисление бонусов, с пагинацией и входными фильтрами
POST api/bonuses/BonusIdAction	Получение информации о бонусе и обновление бонуса начисления: даты активации\сгорания бонуса и состояние его активности

Children

Контроллер для работы с детьми

API	Description
POST api/children/ClientChildrenInfo	Получение информации о детях клиента
POST api/children/ClientChildrenCreate	Добавление информации о детях клиента
POST api/children/ClientChildrenUpdate	Обновление информации о ребенке клиента
POST api/children/import	Массовый импорт детей из Excel
POST api/children/GetChildrenImportState	Получение состояние импорта детей из Excel

Event

Event controller

API	Description
POST api/event/EventTypeInfo	Получение информации о типах отслеживаемых событий на сервере
POST api/event/EventRulePagingInfo	Получение правил на события в программе лояльности, с входными фильтрами и пагинацией
POST api/event/EventRuleActionPagingInfo	Получение набора действий по правилу на событие, с входными фильтрами и пагинацией
POST api/event/EventRuleDataAction	Создание/изменение/получение информации о действии по правилу на событие
POST api/event/EventRuleAction	Создание/изменение/получение данных по правилу на событие

Card

Контроллер для работы с картыми ПЛ

API	Description
POST api/card/GetCard	Получает базовую инфу по карте ПЛ (статус, тип, оператор, баланс, кол-во покупок, сумма покупок, кол-во начисленных бонусов, кол-во списанных бонусов
POST api/card/CardLevelUpdate	Изменение старого уровня карты на новый
POST api/card/CardLevelInfo	Получение информации об уровнях карты в программе, накоплениях и порогах накоплений
POST api/card/import	Массовый импорт накоплений из Excel
POST api/card/GetCardUpdateImportState	Получение состояние импорта накоплений из Excel
POST api/card/CardStatusChange	Изменяет статус карты и записывает это в лог
POST api/card/CardMerge	Замена номера карты клиента
POST api/card/CardBonusActiveBurn	Получение информации о бонусах, которые сгорят или активируются на карте клиента в заданный промежуток времени, с детализацией
POST api/card/CardTypeAction	Получение статусов и изменение статуса указанной карты участника программы лояльности

Item

Контроллер для работы с позициями чеков

API	Description
POST api/item/import	Массовый импорт позиций чеков из Excel
POST api/item/GetItemImportState	Получение состояние импорта позиций чеков из Excel

Marketing

Marketing controller

API	Description
POST api/marketing/CampaignAction	Создание / изменение / получение информации о кампании
POST api/marketing/ShortUrlCreate	Формирование короткой ссылки из длинной с дополнительными параметрами
POST api/marketing/MarketlistPagingInfo	Получение информации о созданных маркетинговых списках карт, с фильтрами и пагинацией
POST api/marketing/MarketListAction	Создание и изменение маркетингового списка карт
POST api/marketing/ListCardAction	Ручное добавление или удаление карт из маркетингового списка и проверка на существование карты клиента в маркетинговом списке
POST api/marketing/MarketlistPurchases	Данные о покупках клиентов за период, по маркетинговому списку, в привязке к рассылкам и правилам, с детализацией и без
POST api/marketing/CommunicationPagingInfo	Получение рассылок доступных для отображения пользователю, с пагинацией и входными фильтрами
POST api/marketing/CommunicationAction	Создание / изменение / получение информации о рассылке
POST api/marketing/CampaignPagingInfo	Получение информации о кампании, с пагинацией и входными фильтрами
POST api/marketing/SampleCreate	Создание/получение информации/пересчёт выборки клиентов и маркетингового списка
POST api/marketing/SendMessageProcess	Отправка сообщения по заданному каналу коммуникации заданному клиенту или пользователю
POST api/marketing/MarketlistRepeatAction	Создание маркетингового списка клиентов из другого списка клиентов, клиентами которого, в заданный промежуток времени, не было совершено необходимого действия
POST api/marketing/MarketlistTemplate	Получение данных о количестве клиентов, которые соответствуют заданным фильтрам или создание маркетингового списка клиентов
POST api/marketing/MessagePagingInfo	Получение информации об отправленных сообщениях, с пагинацией и входными фильтрами
POST api/marketing/MessageTemplateAction	Добавление, изменение, получение информации о шаблоне сообщения
POST api/marketing/MessageTemplatePagingInfo	Получение информации о шаблонах сообщений Оператора, с входными фильтрами и пагинацией
POST api/marketing/MarketlistTemplateParametersAction	Получение данных (параметров/критериев), с которыми был создан маркетинговый список клиентов

Unisender

Контроллер для работы с сервисом рассылок Unisender Go

API	Description
POST api/unisender/SendEmail	Отправка E-mail заданному адресату по шаблону, текстом или готовый html
POST api/unisender/WebhookEmail	Получение вебхуков по статусу ранее отправленных E-mail писем от Unisender Go
GET api/unisender/WebhookEmail	Получение вебхуков по статусу ранее отправленных E-mail писем от Unisender Go
POST api/unisender/EmailValidation	Проверка E-mail на существование

Mobile

API	Description
POST api/mobile/DeviceCreate	Создание в БД устройства
POST api/mobile/MobileOperatorCreate	Создание мобильного оператора
POST api/mobile/MobileOperatorInfo	Получение информации о мобильном операторе
POST api/mobile/ClientDevice	Запись данных о приложении и клиенте после авторизации
POST api/mobile/ClientOffers	Получение информации о предложениях, которые предназначены для клиента
POST api/mobile/ClientOfferPurchaseCreate	Покупка клиентом предложения/акции за бонусы
POST api/mobile/ClientOfferPurchaseInfo	Получение истории покупок/предложений клиента за бонусы
POST api/mobile/ClientOfferAction	Добавление/удаление в избранное, изменение статуса отображения купленных предложений
POST api/mobile/SendCode	Отправка кодов подтверждения по различным каналам коммуникации
POST api/mobile/ConfirmCode	Валидация кодов подтверждения по каналам коммуникации

File

API	Description
POST api/file/FromToBase64	Генерация Base64 по заданному url или сохранение в изо из заданного Base64
POST api/file/UrlToFormData	Сохранение файла из form-data
POST api/file/BarCodeCreate	Создание и сохранение штрихкода

Service

Service controller

API	Description
POST api/service/SiteConfig	Получение конфига сайта-виджета записи на услуги
POST api/service/SitePageCalculate	Получение конфига страницы "Калькулятор" веб-виджета расчёта стоимости и записи на услугу
POST api/service/SitePageAdditionalService	Получение конфига страницы "Доп. услуги" веб-виджета расчёта стоимости и записи на услугу
POST api/service/ServiceCalculate	Расчёт стоимости услуги без записи и с записью в БД
POST api/service/PosDateTimeFree	Получение дат, в которых есть свободное время для записи и времени в дате, по точке продаж
POST api/service/PosPagingInfo	Получение информации о точках продаж, в которых можно заказать услугу, с входными фильтрами и свободными датами для записи
POST api/service/BuyerAction	Создание, изменение, получение информации о покупателе услуги и его автомобилях
POST api/service/SitePageAdditionalCondition	Получение конфига страницы "Дополнительные условия/опции"
POST api/service/RegistrationAction	Добавление, изменение, получение данных о записи на услуги
POST api/service/PosDateTime	Получение времени записей в конкретной дате и точке продаж с идентификаторами записей и статусом "свободности" времени для записи
POST api/service/PosCalendar	Получение календаря записей по точке продаж с учётом входных фильтров
POST api/service/RegistrationPagingInfo	Получение записей на услуги, с учётом входных параметров и пагинацией
POST api/service/SitePageStatusRegistration	Получение конфига страницы "Статус записи" веб-виджета расчёта стоимости и записи на услугу
POST api/service/DataAction	Получение данных справочников сервиса "Услуги" и изменение данных записей клиентов
POST api/service/BuyerPagingInfo	Получение данных покупателей, с пагинацией и входными фильтрами
POST api/service/AddServicePriceAction	Получение данных справочников, из которых складывается конечная стоимость доп. услуг и услуг комплекса услуг, с пагинацией, фильтрами, а также с возможностью изменения активности и стоимости услуги
POST api/service/BuyerCarAction	Получение, добавление, изменение автомобилей покупателя
POST api/service/PosPropsPagingInfo	Получение настроек точек продаж, участвующих в продаже услуг, с пагинацией и входными фильтрами
POST api/service/PosPropsAction	Создание, изменение и получение настроек точки продаж, участвующей в продаже услуг

Goods

Goods controller

API	Description
POST api/goods/CatalogPosition	Создание/удаление/редактирование папки существующего товарного каталога
POST api/goods/GoodAction	Создание нового и изменение ранее созданного товара
POST api/goods/GoodPriceRemain	Добавление или обновление остатков и цен по товару
POST api/goods/GoodImageAction	Добавление изображения существующему товару в БД Mloyalty
POST api/goods/GoodPropsAction	Добавление, изменение, удаление свойств и атрибутов ранее созданного товара
POST api/goods/GoodInfo	Получение информации о товаре по его идентификатору или гуиду
POST api/goods/GoodsPagingInfo	Получение информации о товарах в зависимости от заданных фильтров
POST api/goods/CatalogBrands	Получение информации о брендах, которые представлены в каталоге
POST api/goods/GoodsFilterProps	Получение информации о фильтрах товарах и их значениях в зависимости от входных параметров
POST api/goods/CatalogStructure	Получение структуры каталога по его идентификатору или структуры папки каталога по её гуиду, идентификатору или наименованию
POST api/goods/GoodlistPagingInfo	Получение информации о списках товаров, с пагинацией и фильтрами
POST api/goods/GoodlistAction	Добавление, изменение, получение информации о товарах в списке товаров, с пагинацией и фильтрами
POST api/goods/DisplayProcess	Управление отображением (доступность для пользователя) каталога, разделов каталога, товаров, их свойств и характеристик
POST api/goods/ItemListAction	Добавление/изменение статического списка кодов товаров и получение информации о товарах в списке
POST api/goods/GoodsDataAction	Получение информации по товару: свойства, склады, изображения и изменение их видимости (отображение) или удаление
POST api/goods/GoodsCatalogDataAction	Получение и изменение информации по сущностям товарного каталога: склад, бренд, свойство, папка каталога
POST api/goods/ItemListPagingInfo	Получение списка кодов товаров, с входными фильтрами и пагинацией
POST api/goods/GoodTagsAction	Добавление/изменение/удаление тегов товару, которые отображаются пользователю (хит, распродажа, акция и т.д.)
POST api/goods/CatalogEntitySearch	Поиск товаров/брендов/папок каталога по части заданного наименования
POST api/goods/CatalogPositionListPagingInfo	Получение информации о списках папок товарного каталога, с пагинацией и фильтрами
POST api/goods/CatalogPositionListAction	Добавление, изменение, получение информации о позициях каталога в списке позиций каталога, с пагинацией и фильтрами
POST api/goods/GoodSystemData	Получение значений фильтров, свойств, справочников по товару, с входными фильтрами
POST api/goods/NomenclatureSpeciesAction	Добавление/изменение/получение данных по видам номенклатуры в товарном каталоге
POST api/goods/NomenclatureSpeciesListAction	Добавление/изменение/получение данных по списку видов номенклатуры в товарном каталоге
POST api/goods/NomenclatureSpeciesListPagingInfo	Получение всех списков видов номенклатуры в товарном каталоге, с входными фильтрами и пагинацией
POST api/goods/CatalogDataActionPagingInfo	Получение информации о сущностях таблицах товарного каталога, с входными фильтрами, с пагинацией

Frontol

API	Description
POST api/frontol/document	Метод работы с документом
POST api/frontol/client	Метод работы с клиентом

BirthdayRule

BirthdayRule controller

API	Description
POST api/birthdayrule/DataAction	Создание и редактирование действий для по правилу для механики "День рождения"
POST api/birthdayrule/ActionPagingInfo	Получение информации о действиях по правилу, настроенных по механике "День рождения", с пагинацией и входными фильтрами
POST api/birthdayrule/PagingInfo	Получение информации о правилах, настроенных по механике "День рождения", с пагинацией и входными фильтрами
POST api/birthdayrule/UserAction	Создание и редактирование действий для по правилу для механики "День рождения")

Lead

API	Description
POST api/lead/LeadCreate	Создание лида
POST api/lead/LeadInfo	Получение информации по лиду
POST api/lead/LeadMessageCreate	Создание сообщения лиду
POST api/lead/LeadMessageInfo	Получение сообщений отправленных лиду
POST api/lead/LeadMessageUpdate	Изменение сообщения лиду
POST api/lead/LeadsPagingInfo	Получение информации о лидах, с пагинацией, на основании входных фильтров
POST api/lead/FilterData	Получение списка фильтров и их значений для таблиц сервиса "лиды"
POST api/lead/FilterDataChange	Изменение фильтров лида по идентификатору лида (статус, тип, ответственный, статус обработки, источник, группа)
POST api/lead/LeadUpdate	Изменение данных лида

SertCard

SertCard controller

API	Description
POST api/sertcard/SertCardInfo	Получение информации по подарочному сертификату
POST api/sertcard/SertCardUpdate	Изменение информации по подарочному сертификату
POST api/sertcard/SendCode	Отправка кода подтверждения по указанному типу коммуникации
POST api/sertcard/ConfirmCode	Валидация кода подтверждения
POST api/sertcard/SiteConfig	Получение настроек сайта
POST api/sertcard/SiteFaq	Получение ответов на часто задаваемые вопросы для покупателя и получателя подарочных сертификатов
POST api/sertcard/SiteWork	Получение информации для блока "Как это работает"
POST api/sertcard/SiteRule	Получение информации для блока "Правила"
POST api/sertcard/SiteDoc	Получение текста документов "Оферта" и "Политика конфиденциальности"
POST api/sertcard/SiteSession	Открытие новой сессии на основании закрытия старой сессии сайта на сервере
POST api/sertcard/SitePageOrder	Получение конфига для страницы "Заказы"
POST api/sertcard/SitePageContacts	Получение конфига для страницы "Контакты"
POST api/sertcard/SitePageOrderConfirm	Получение конфига для страницы "Подтверждение заказа"
POST api/sertcard/SitePageBasket	Получение конфига для страницы "Корзина"
POST api/sertcard/SitePageBurger	Получение конфига для страницы "Бургер"
POST api/sertcard/SitePageStatusPayment	Получение конфига для страницы "Статус оплаты"
POST api/sertcard/SitePageSertOwner	Получение конфига для страницы "Сайт получателя сертификата"
POST api/sertcard/Order	Создание заказа или изменение ранее созданного заказа по продаже подарочных сертификатов
POST api/sertcard/SertCards	Генерация номеров подарочных сертификатов для ранее созданной серии сертификатов
POST api/sertcard/SertCardIdentify	Проверка возможности использования подарочного сертификата у Оператора/Партнера/Точки/Клиента
POST api/sertcard/PurchasePos	Фиксация факта продажи подарочного сертификата в точке продаж
POST api/sertcard/RedeemedPos	Списание или возврат средств на подарочный сертификат в точке продаж
POST api/sertcard/Owner	Создание и изменение владельца сертификата и привязка друга к владельцу сертификата
POST api/sertcard/SecretIdentify	Проверка валидности введённого пинкода сертификата
POST api/sertcard/OrderForSale	Получение необходимого количества сертификатов и данных по ним для продажи во внешней системе
POST api/sertcard/SendForEmail	Отправка подарочного сертификата по E-mail
POST api/sertcard/SalesPaging	Получение информации о продажах подарочных сертификатов в зависимости от заданных фильтров
POST api/sertcard/DocumentTemplate	Подготовка документа с информацией о подарочном сертификате в формате .pdf для рассылки, печати или сохранения на устройстве пользователя
POST api/sertcard/PurchaseStatus	Проверка подарочного сертификата на возможность его продажи или возврата
POST api/sertcard/NumberFromGoods	Генерация номера сертификата на основании продажи товара типа "Сертификат"
POST api/sertcard/SertcardPaging	Получение информации о сгенеренных сертификатах, с фильтрами и пагинацией
POST api/sertcard/FilterData	Получение списка фильтров и их значений для таблицы "Сертификаты"
POST api/sertcard/SertCardMerge	Перенос средств с подарочных сертификатов (объединение сертификатов)
POST api/sertcard/SertcardGeneratePagingInfo	Получение информации о генерации сертификатов, с входными фильтрами и пагинацией
POST api/sertcard/SertcardSeriesPagingInfo	Получение информации о сериях сертификатов, с входными фильтрами и пагинацией
POST api/sertcard/SertcardSeriesAction	Создание/изменение/получение информации по серии сертификатов
POST api/sertcard/SertcardGenerateType	Получение информации о возможных типах генерации номеров подарочных сертификатов в системе
POST api/sertcard/RedeemedPaging	Получение информации о списаниях средств с сертификатов, с пагинацией и входными фильтрами

SendPulse

Контроллер для работы с сервисом рассылок SendPulse

API	Description
POST api/sendpulse/SendEmail	Отправка E-mail по заданному идентификатору шаблона

Client

API	Description
POST api/client/GetConfirmCode	Проверка кода и валидация номера телефона
POST api/client/SetClientPassword	Установка пароля клиента
POST api/client/GetRegistrationUser	Регистрация Участника в ЛКУ программы лояльности
POST api/client/GetSendVerificationCode	Отправка проверечного кода в SMS сообщении на указанный номер телефона
POST api/client/ClientLogin	Авторизация Участника в ЛКУ по логину/паролю или через привязанный аккаунт социальной сети.
POST api/client/GetCheques	Получение чеков по заданному номеру карты.
POST api/client/GetClient	Получение информации о картах Участника.
POST api/client/ChangeClient	Изменение данных Участника по заданному идентификатору
POST api/client/GetClientCards	Получение списка карт Участника программы лояльности
POST api/client/BalanceGet	Получение баланса бонусных баллов по номеру карты, либо по номеру телефона Участника программы лояльности.
POST api/client/GetPartners	Возвращает информацию о Партнере
POST api/client/GetCampaigns	Возвращает информацию об акции
POST api/client/ClientPartnerSelect	Добавление\удаление клиента у партнера
POST api/client/ClientCampaignSelect	Добавление\удаление клиента из акции
POST api/client/ClientAddCard	Добавление карты для Участника программы лояльности
POST api/client/LeaveMessage	Отправка сообщения по электронной почте
POST api/client/SendEmailCode	Отправка проверечного кода на указанный адрес электронной почты.
POST api/client/ValidateEmail	Проверка кода и валидация электронной почты
POST api/client/AddEmail	Добавление адреса электронной почты для Участника программы лояльности
POST api/client/AddIDFB	Добавление аккаунта Facebook для Участника программы лояльности
POST api/client/AddIDOK	Добавление аккаунта Odnoklassniki для Участника программы лояльности
POST api/client/AddIDVK	Добавление аккаунта VK для Участника программы лояльности
POST api/client/Delete	Удаление клиента из программы лояльности
POST api/client/GetPersonalCampaigns	Возвращает персональное предложение Участника (потерялся public class Campaing).
POST api/client/SelectPreferences	Возвращает "любимые" категории товаров
POST api/client/AddPhone	Привязывает номер телефона к заданному Участнику, устанавливает заданный номер телефона как коммуникационный.
POST api/client/ClientGetPreferences	Возвращает "любимые" категории товаров Участника
POST api/client/GetChequeDetail	Запрос детализации чека по заданному ID чека
POST api/client/SetClientDevice	Записать данные об устройстве Участника для отправки PUSH-уведомлений
POST api/client/CardStatistics	Получение статистики по карте
POST api/client/ClientInfo	Получение данных Участника по заданному номеру телефона или номеру карты.
POST api/client/CardAggregation	Статистика по картам за периода
POST api/client/ClientCreate	Создание профиля Участника программы лояльности
POST api/client/ClientUpdate	Обновление профиля Участника программы лояльности
POST api/client/ClientPasswordChange	Обновление пароля Участника программы лояльности
POST api/client/ClientUpdateCommunication	Обновление способа связи с клиентов
POST api/client/ClientBonuses	Получение бонусов Участника программы лояльности не относящиеся к чекам.
POST api/client/CardBonuses	Получение бонусов карты не относящиеся к чекам.
POST api/client/ActivateCard	Активация карты на списание
POST api/client/BonusesNotForPurchases	Получение списка бонусов не за покупки
POST api/client/CheckEmailForFree	Проверяет принадлежит ли email какому-либо участнику ПЛ
POST api/client/ClientMessageInfo	Получение информации о сообщениях клиента
POST api/client/ClientInfoSurname	Поиск клиентов по фамилии
POST api/client/ClientCreateIshop	Создание и привязка идентификатора клиента интернет-магазина и идентификатора клиента в лояльности
POST api/client/ClientLevelsInfo	Получение информации об уровне клиента и его показателях относительно других уровней в программе
POST api/client/ClickDone	Фиксация клика на ссылку/плитку/экран/товар участником программы лояльности
POST api/client/ClientOrdersInfo	Информация о заказах клиента с детализацией или о конкретном заказе
POST api/client/ClientInfoPeriod	Получение информации по клиентам, которые совершили нужное действие в указанный период
POST api/client/ClientContragent	Запись фактов привязок идентификаторов клиента и контрагента
POST api/client/OperationHistory	Получение информации об операциях клиента (бонусы, чеки, заказы), с пагинацией
POST api/client/ActionConfirm	Создание и обновление секретных кодов для подтверждения действий клиента
POST api/client/LeadsPagingInfo	Получение информации об обращениях клиента, за период, с пагинацией
POST api/client/BotAction	Добавление, обновление, получение информации о связке идентификатора участника программы лояльности и идентификатора пользователя в мессенджере / соц. сети через бота Оператора программы лояльности
POST api/client/ClientPosDistance	Приём геолокации клиента или фака фиксации нахождения клиента рядом с точкой продаж, в которой установлен bluetooth маячок для дальнейшей коммуникации или иных действий по клиенту
POST api/client/ClientFriendsAction	Привязка друга клиентом и получение статистической информации о друзьях и бонусах за приведённых друзей клиента
POST api/client/ClientsPagingInfo	Получение информации о клиентах, с пагинацией и входными фильтрами
POST api/client/ClientFavoriteAction	Добавление, получение, изменение данных об избранных и любимых товарах/магазинах клиента
POST api/client/ClientsCounter	Получение значений счётчиков по клиентам на основании входных фильтров
POST api/client/ChangeLog	Получение лога изменения данных клиента
POST api/client/ClientPromoAction	Привязка клиента к конкретной маркетинговой инициативе (купон, промокод, любимый товар, любимый магазин и т.д.)
POST api/client/ClientInfoMobile	Получение информации о наличии у клиента моб. приложения и его активности в нём

News

News controller

API	Description
POST api/news/NewsAction	Создание/изменение/получение информации о новости
POST api/news/NewsPagingInfo	Получение рассылок доступных для отображения пользователю, с пагинацией и входными фильтрами

Order

Order controller

API	Description
POST api/order/OrderInvoice	Создание/изменение/отмена заказа участника программы лояльности
POST api/order/OrderInvoiceAction	Добавление нового статуса по заказу и накладной, а также сбрасывание всех применённых поощрений к заказу
POST api/order/OrderInvoicesInfo	Получение данных по всем накладным заказа клиента с детализацией
POST api/order/BasketCreate	Создание корзины клиенту или анонимному пользователю
POST api/order/BasketPositionCreate	Добавление товара в корзину
POST api/order/BasketPositionAction	Изменение или удаление товара корзины
POST api/order/BasketInfo	Получение информации о составе корзины, её стоимости и применённых поощрениях
POST api/order/BasketAction	Осуществление действий по корзине (очистить, скинуть поощрения, рассчитать поощрения)
POST api/order/SystemDataAction	Создание, изменение получение информации по данным справочников: статусы заказа, статусы оплат заказа, типы оплат
POST api/order/PosesPickUp	Получение точек самовывоза для корзины/заказа

Values

API	Description
POST api/values/ChequeAdd	Расчёт и применение поощрений по чеку покупки, регистрация чека покупки и возврата на процессинге
POST api/values/GetAllShopsByPartner	Получение списка магазинов Партнёра
POST api/values/GetCheques	Получение чеков по заданному номеру карты.
POST api/values/GetGifts	Получение списка сертификатов
POST api/values/GetSmsSentMessage	Получение списка SMS-отправлений
POST api/values/GetConfirmCode	Проверка кода и валидация номера телефона.
POST api/values/SetClientPassword	Установка/изменение пароля Участника.
POST api/values/GetRegistrationUser	Регистрация Участника в ЛКУ программы лояльности
POST api/values/GetSendVerificationCode	Отправка проверечного кода в SMS сообщении на указанный номер телефона
POST api/values/ClientLogin	Авторизация Участника в ЛКУ по логину/паролю или через привязанный аккаунт социальной сети.
POST api/values/ChangeClient	Изменение данных Участника по заданному идентификатору
POST api/values/SendEmailCode	Отправка проверечного кода на указанный адрес электронной почты.
POST api/values/ValidateEmail	Проверка кода и валидация электронной почты
POST api/values/Refund	Регистрация чека возврата на Процессинге.
POST api/values/OperatorStatistics	Получение полной информации по Оператору за период
POST api/values/GetCampaigns	Получение Акций по заданному идентификатору Участника программы лояльности.
POST api/values/ClientInfo	Получение данных Участника по заданному номеру телефона или номеру карты.
POST api/values/ClientUpdate	Обновление профиля Участника программы лояльности.
POST api/values/CancelLastCheque	Отмена последнего зарегистрированного чека на Процессинге.
POST api/values/ClientCreate	Создание профиля Участника программы лояльности
POST api/values/GetClient	Получение информации о картах Участника.
POST api/values/GetChequesByCard	Получение информации о чеках привязанных к карте
POST api/values/ClientImport	Импорт клиентской базы
POST api/values/GetClientImportState	Получение количества элементов очереди в обработки импорта клиентов
POST api/values/CheckImport	Импорт чеков
POST api/values/GetChequeImportState	Получение количества элементов очереди в обработки импорта чеков
POST api/values/PosStatistics	Статистика по торговой точке за период
POST api/values/ChequeAggregation	Статистика по чекам за период
POST api/values/ClientAggregation	Статистика по клиентам за период
POST api/values/ChequesBonuses	Статистика по начислению бонусов
POST api/values/OperatorClients	Статистика по клиентам Оператора
POST api/values/BuysImport	Импорт базы проведённых чеков
POST api/values/CardBonuses	Получение бонусов карты не относящиеся к чекам.
POST api/values/OperatorClientsManager	Возращает информацию о клиентах на страницу клиентов Оператора
POST api/values/SegmentationAge	Данные для страницы Аналитика LCManager
POST api/values/GetClientBonuses	Данные для страницы Аналитика LCManager, блок БОНУСЫ
POST api/values/ClientBaseStructure	Данные для страницы Аналитика LCManager
POST api/values/ClientBaseActive	Данные для страницы Аналитика LCManager
POST api/values/ClientAnalyticMoney	Данные для страницы Аналитика LCManager
POST api/values/GainOperatorPeriod	Возращает средний чек и выручку Оператора\Партнёра\ТТ по месяцам
POST api/values/RefundOperatorPeriod	Возращает сумму возратов Оператора\Партнёра\ТТ по месяцам
POST api/values/ClientOperatorPeriod	Возвращает количество зарегестрированных клиентов Оператора\Партнёра\ТТ по месяцам
POST api/values/ManagerSendCode	Отправка кода подтверждения менеджером
POST api/values/SetManagerPassword	Установка/изменение пароля Участника.
POST api/values/UserInfo	Информация об операторе
POST api/values/ActivateCard	Активация карты на списание
POST api/values/PhoneChange	Смена номера телефона клиента
POST api/values/ImportOperatorGoods	Выборка товаров Оператора
POST api/values/OperatorGoods	Выборка товаров Оператора
POST api/values/SaveOperatorGoodList	Сохранение списка товаров
POST api/values/OperatorGoodList	Получает списки товаров, отдельного оператора
POST api/values/ChangeOperatorGoodList	Изменение видимости списка товаров
POST api/values/VerificationPromocode	Проверка промокода
POST api/values/GetBookkeepings	Получает сверку по оператору, партнеру или торговой точке

Coupon

API	Description
POST api/coupon/CouponInfo	Получение информации по купону
POST api/coupon/CouponAction	Создание/изменение/получение информации по купону/промокоду
POST api/coupon/PagingInfo	Получение информации о купонах с входными фильтрами и пагинацией
POST api/coupon/SeriesAction	Создание/изменение/получение информации по серии купонов
POST api/coupon/SeriesPagingInfo	Получение информации о сериях купонов с входными фильтрами и пагинацией
POST api/coupon/CouponChequesPagingInfo	Получение данных по чекам с купонами, с входными фильтрами и пагинацией

Bitrix24

Bitrix24 controller

API	Description
POST api/bitrix24/Webhooks	Вебхук
POST api/bitrix24/ContactCheckPhone	Проверка существования контакта по номеру телефона из БД mloyalty в Битрикс24
POST api/bitrix24/ContactInfo	Получение информации о контакте из Битрикс24 по его идентификатору
POST api/bitrix24/ContactCreate	Создание контакта в Битрикс24 на основании данных об участнике программы лояльности
POST api/bitrix24/ContactUpdate	Обновление данных контакта в Битрикс24 на основании изменившихся данных у клиента в БД mloyalty

YandexTanker

API	Description
POST api/yandextanker/add	Добавление карты лояльности
POST api/yandextanker/confirm	Отправка кода подтверждения карты лояльности
DELETE api/yandextanker/remove	Удаление карты лояльности
GET api/yandextanker/balance	Сведения о балансе пользователя
POST api/yandextanker/purchase	Начисление бонусных баллов

Cheque

Cheque controller

API	Description
POST api/cheque/ChequeItems	Получение информации о позициях чека по его идентификатору
POST api/cheque/ChequesPagingInfo	Получение информации о чеках, с пагинацией и входными фильтрами
POST api/cheque/RuleForCheque	Получение информации о правилах на покупки и правилах на события, которые сработали в чек, по идентификатору чека
POST api/cheque/ChequeruleTrackingInfo	Получение статистической информации о выделенных для отслеживания правил на покупки
POST api/cheque/ChequeRuleAction	Создание, изменение и получение информации о правиле на чек или позицию чека
POST api/cheque/ChequeRulePagingInfo	Получение правил на покупки доступных для отображения пользователю, с пагинацией и входными фильтрами
POST api/cheque/ChequeBonusAction	Списание активных/неактивных/всех бонусов по чеку с указанным источником бонусов и возвращает активный/неактивный/весь остаток бонусов по чеку

Questionnaire

Questionnaire controller

API	Description
POST api/questionnaire/SiteConfig	Получение настроек сайта-виджета опросов
POST api/questionnaire/SitePageConfig	Получение настроек страницы сайта-виджета опросов по её идентификатору
POST api/questionnaire/QuestionInfo	Получение вопроса и вариантов ответов на него по идентификатору опросника
POST api/questionnaire/NextQuestion	Получение следующего вопроса в зависимости от ответа на предыдущий
POST api/questionnaire/AnswersCommit	Запись всех ответов на все вопросы из опросника
POST api/questionnaire/Questionnaires	Получение опросов доступных для отображения и их настройки, в зависимости от входных фильтров
POST api/questionnaire/QuestionnaireCommitResult	Получение информации о клиентах, которые проходили опрос и их ответах на вопросы, с пагинацией
POST api/questionnaire/QuestionnaireAction	Добавление нового, изменение существующего, получение информации по опросу
POST api/questionnaire/QuestionGroupAction	Добавление новой или изменение существующей группы вопросов и получение всех групп вопросов в опросе
POST api/questionnaire/AnswerAction	Добавление нового, изменение существующего или получение информации по ответу, на основании идентификатора ответа или вопроса
POST api/questionnaire/QuestionAction	Добавление нового, изменение существующего или получение информации по вопросу на основании идентификатора ответа
POST api/questionnaire/DynamicRuleAction	Добавление нового, изменение существующего или получение информации по правилам динамического определения следующего вопроса на основании ответа на предыдущий вопрос
POST api/questionnaire/ShownRuleAction	Добавление нового, изменение существующего или получение информации по правилу отображения опроса, на основании идентификатора опроса
POST api/questionnaire/QuestionnairePagingInfo	Получение информации об опросах оператора, с пагинацией и входными фильтрами
POST api/questionnaire/QuestionnaireTypeInfo	Получение информации о типах опросов (справочник)
POST api/questionnaire/TagsAnswersAction	Добавление, изменение и получения тега ответа на вопрос в опросе
POST api/questionnaire/QuestionnairesData	Получение массивов данных по опросу: группы вопросов, вопросы, ответы

Level

Контроллер для работы с уровнями оператора

API	Description
POST api/level/OperatorLevelsInfo	Получение информации об уровнях оператора
POST api/level/OperatorLevelsCreate	Добавление информации об уровнях оператора
POST api/level/OperatorLevelsUpdate	Обновление информации об уровнях оператора
POST api/level/BurnConfirmPeriod	Получение информации о клиентах и уровнях карты клиента, у которых в заданный промежуток времени будет инициирована процедура подтверждения уровня карты или уже была пройдена
POST api/level/LevelsChangeHistory	Получение информации об изменении уровней карт в программе лояльности, за период, с учётом входных фильтров и пагинацией
POST api/level/LevelClients	Получение информации о количестве клиентов, карты которых находятся на заданном уровне, с детализацией и без
POST api/level/LevelsStatistics	Получение статистической информации об уровнях карт в программе лояльности: кол-во клиентов на уровнях, подтверждение и пересчёт уровней по месяцам

Evotor

API	Description
POST api/evotor/ManagerCreate	Регистрация нового менеджера для Приложения
POST api/evotor/ManagerLogin	Авторизация менеджера для Приложения

Site

API	Description
GET api/site/test1	No documentation available.
POST api/site/GetSegments	Получение списка сегментов
POST api/site/GetCategories	Получения списка категорий?
POST api/site/GetCities	Получение списка городов
POST api/site/GetPartners	Получение списка партнеров по заданным параметрам
POST api/site/GetPartner	Получение подробной информации о партнере
POST api/site/GetCampaigns	Получение списка акций
POST api/site/GetCampaign	Получение подробной информации об акции
POST api/site/GetPoses	Получение списка торговых терминалов
POST api/site/GetPartnerInfo	Получение информации о партнере
POST api/site/GetCampaignInfo	Получение информации об акции
POST api/site/GetClient	Получение информации об участнике программы лояльности
POST api/site/LeaveMessage	Отправка сообщения по электронной почте
POST api/site/GetFaq	Получение FAQ
POST api/site/GetCampaignDetail	Получение детализированной информации об акции
POST api/site/BecomePartner	Регистрация нового партнера программы лояльности
POST api/site/LoyaltyVidgetConfig	Получение настроек виджета системы лояльности

Apple

Apple controller

API	Description
POST api/apple/SendPush	Отправка push

Bookkeeping

СВЕРКА или БУХГАЛТЕРИЯ

API	Description
POST api/bookkeeping/GetBookkeepings	Получает сверку по оператору, партнеру или торговой точке

Reactivation

Reactivation controller

API	Description
POST api/reactivation/ClientReport	Получение данных о состоянии статуса реактивации, по указанному правилу реактивации, за период и входными фильтрами
POST api/reactivation/RulePagingInfo	Получение правил реактивации с входными фильтрами
POST api/reactivation/PosClientReport	Получение сгруппированных данных о результатах реактивации клиентов в разбивке по точкам продаж, по указанному правилу реактивации, за период и входными фильтрами

User

User controller

API	Description
POST api/user/SendCode	Отправка кодов подтверждения пользователю на указанный канал коммуникации
POST api/user/ConfirmCode	Валидация кодов подтверждения, ранее отправленных пользователю
POST api/user/AppDevice	Добавление нового AppDevice для отправки push-уведомления пользователю
POST api/user/RememberMessage	Отправка кода подтверждения пользователю ЛК для смены/получения пароля от ЛК
POST api/user/RememberConfirm	Валидация кода подтверждения для смены/получения пароля пользователя от ЛК
POST api/user/UserAction	Добавление, изменение, получение информации о пользователе, с входными фильтрами

System

System controller

API	Description
POST api/system/ShortLong	Запись данных о переходах по коротким ссылкам со сбором доп. данных и возврат длинной ссылки
POST api/system/TransferData	Передача данных во внешний url-сервис и получение идентификатора записи этих данных
POST api/system/TransferDataInfo	Получение идентификаторов добавленных или измененных сущностей, за период, с фильтрами
POST api/system/ChequeItems	Получение информации о позициях чека по его идентификатору
POST api/system/TransferDataAction	Запись факта обработки события из БД mloyalty во внешнем сервисе, на основании идентификатора события
POST api/system/ErrorPosRequest	Логирование запросов к API MLoyalty, которые привели к ошибке, включая код и текст ошибки
POST api/system/TransferDataServiceAction	Создание, изменение, получение, удаление данных о настройках для подключения процессинга к внешнему сервису
POST api/system/EntitySearchProcess	Поиск идентификаторов сущностей по наименованию сущности
POST api/system/DocumentUrlFromTemplate	Создание ссылки на файл, созданный из шаблона, на основании замены переменных
POST api/system/BonusHoldPagingInfo	Получение информации о захолдированных бонусах на картах клиентов, с пагинацией и входными фильтрами
POST api/system/BonusHoldCancelProcess	Отмена холдирования бонусов на картах клиентов по заданным критериям: период, точка продаж, список идентификаторов холдирования
POST api/system/BonusHoldHistory	Получение данных об операциях холдирования бонусов на основании входных фильтров, с пагинацией
POST api/system/ClientCheckRegistration	Проверка номера телефона из внешнего сервиса на существование учётной записи в программе лояльности Оператора
POST api/system/TransferDataServiceClients	Получение аналитической информации по результатам работы внешнего сервиса в части привлечения клиентов в программу лояльности
POST api/system/TransferDataClientAction	Создание, изменение и получение информации о клиенте программы лояльности внешним сервисом
POST api/system/EntitySearchProcessList	Поиск сущностей в списках, по наименованию (точка продаж, код товара, товар, карта и т.д.)
POST api/system/Status	Проверка статуса доступности сервисов

Reports

API	Description
POST api/reports/ClientBuys	Очтёт о покупках клиента Оператора за период
POST api/reports/Buys	Очтёт о покупках Оператора за период
POST api/reports/PosClientPeriod	Отчёт по клиентам ТТ за период
POST api/reports/PosSalePeriod	Отчёт по продажам ТТ за период
POST api/reports/OperatorClient	Отчёт по клиентской базе Оператора программы лояльности
POST api/reports/OperatorSales	Отчёт о продажах по программе лояльности оператора
POST api/reports/OperatorBookkeeping	Отчёт для бухгалтерии оператора за период
POST api/reports/PartnerClient	Отчёт по продажам за период у партнера
POST api/reports/PartnerSales	Очтёт о начисление и списание бонусов у партнера
POST api/reports/PartnerBookkeeping	Отчёт для бухгалтерии партнера за период
POST api/reports/OperatorBonus	Отчёт по бонусам не за покупки за период у оператора
POST api/reports/BonusesNoChequeReport	Отчёт по бонусам не за покупки
POST api/reports/GiftsReport	Отчёт по сертификатам
POST api/reports/SmsReport	Отчёт по смс-сообщениям
POST api/reports/BookkeepingReport	Отчёт по сверке
POST api/reports/PosStatistics	Отчёт по ключевым показателям торговых точек за период
POST api/reports/ABCReview	Отчёт о вкладе клиентов в выручку торговых точек (группы А, B, С) с определением маркера активности (Горячий, Тёплый, Холодный) за определённый период
POST api/reports/ClientBirthdayChildrenPeriod	Отчёт по дням рождения детей клиентов в указанный период
POST api/reports/PartnterAndPos	Отчёт по ключевым показателям точек продаж
POST api/reports/SertcardSales	Отчёт по продажам подарочных сертификатов
POST api/reports/SertcardData	Отчёт по подарочным сертификатам
POST api/reports/ClientBirthdayPeriod	Отчёт по дням рождения клиентов в указанный период
POST api/reports/PosTotalData	Получение статистических данных по точкам продаж, за всё время
POST api/reports/RedeemBonusSource	Получение статистических данных по движению указанного типа бонуса в разбивке по точкам продаж, за период
POST api/reports/SertcardRedeemedData	Отчёт о списаниях средств с сертификатов
POST api/reports/SertcardGenerateNumbers	Получение номеров сертификатов в .xlsx, сгенеренных в рамках определённой генерации
POST api/reports/RedeemEventRuleCouponBonus	Отчёт о списанных купонных бонусах с указанием активности клиентов, в разбивке по точкам продаж, с входными фильтрами
POST api/reports/ChequesWithCoupon	Получение информации о продажах, в которых были применены купоны оператора, с входными фильтрами
POST api/reports/CodeItemListSalesPeriod	Получение данных о продажах конкретного кода товара или списка кодов товаров, с входными фильтрами
POST api/reports/MessagePagingInfo	Получение отчёта об отправленных сообщениях клиентам, за период, с фильтрами
POST api/reports/PosConnectPagingInfo	Получение отчёта о магазинах, которые не "авторизовались в api" до определённого времени дня
POST api/reports/FraudPagingInfo	Получение отчёта о попаданиях клиентов в систему фрод-мониторинга
POST api/reports/MarketListClientsDetail	Получение данных по всем клиентам маркетингового списка
POST api/reports/MarketlistPurchases	Получение отчёта о покупках клиентов, которые находятся в маркетинговом списке (за период)

Analytics

Analytics controller

API	Description
POST api/analytics/Structure	Получение данных по сегментацие клиентской базы по возрасту и структуре клиентской базы
POST api/analytics/Dynamic	Получение данных по месячной динамике
POST api/analytics/Money	Получение данных активности клиентской базы и бонусам
POST api/analytics/GainStructure	Получение аналитических данных по выручке в программе лояльности в разрезе структуры и активности клиентской базы
POST api/analytics/OperatorFromCards	Получение данных с максимальными значениями показателей в программе лояльности и данные по количеству карты в разных статусах
POST api/analytics/TotalPartnerPos	Получение аналитической информации по ключевым показателям в программе лояльности по торговой точке или партнеру, за период, в разбивке по месяцам (для графиков)
POST api/analytics/TotalPagingInfo	Получение аналитической информации по ключевым показателям в программе лояльности для пользователя личного кабинета по "его" партнерам и точкам продаж, без детализации по месяцам, с учётом входных фильтров и пагинации
POST api/analytics/DynamicBonus	Получение аналитической информации о движении бонусов (начислено/списано/сгорело), за период, по типам бонусов
POST api/analytics/DynamicReactivation	Получение аналитической информации о работе сервиса реактивации, с входными фильтрами, в разбивке по месяцам года
POST api/analytics/ReactivationRules	Получение аналитической информации по результатам работы правил реактивации, по году или за всё время
POST api/analytics/OperatorData	Получение данных по Оператору программы, за всё время (произвольный набор данных)

YooKassa

YooKassa controller

API	Description
POST api/yookassa/Payment	Создание платежа в Ю-Кассе
POST api/yookassa/Cheque	Создание чека прихода или возврата в онлайн-кассе через Ю-кассу
POST api/yookassa/Webhooks	Изменение статусов платежей и чеков онлайн-кассы
POST api/yookassa/WebhookCommit	Получение статусов платежей (приход/возврат) из Ю-кассы
POST api/yookassa/PaymentCommit	Создание платежа/возврата в онлайн-кассе через Ю-кассу

Bot

Bot controller

API	Description
POST api/bot/Message	Отправка сообщения ботом для заданного адресата
POST api/bot/TelegramSendMessage	Отправка сообщения пользователю/группе/каналу в телеграм через бота
POST api/bot/TelegramWebhook	Вебхук для изменений в Telegram

Pos

API	Description
POST api/pos/OperatorPos	Выборка адресов торговых точек Оператора
POST api/pos/SaveOperatorPosList	Сохранение списка магазинов
POST api/pos/OperatorPosList	Получает списка магазинов, отдельного оператора
POST api/pos/ChangeOperatorPosList	Изменение видимости списка магазинов
POST api/pos/PosGoodsUpdate	Обновление цен товаров по точке продаж
POST api/pos/PosGoodsInfo	Получение цен товаров по точке продаж
POST api/pos/ImportChequeAdd	Импорт добавленных чеков
POST api/pos/PoslistPagingInfo	Получение информации о списках точек продаж, с пагинацией и фильтрами
POST api/pos/PoslistAction	Добавление, изменение, получение информации о точках продаж в списке точек продаж, с пагинацией и фильтрами
POST api/pos/PosAction	Добавление, изменение, получение информации о точке продаж и её настройках
POST api/pos/PosPagingInfo	Получение данных о точках продаж Оператора, с входными фильтрами и пагинацией
POST api/pos/PartnerAction	Добавление и изменение Партнера программы лояльности
POST api/pos/PosConnectPagingInfo	Получение списка точек, которые не выходили на связь в течение суток, с пагинацией и входными фильтрами

Faq

Faq controller

API	Description
POST api/faq/FaqAction	Создание/изменение/получение вопросов в рамках конкретного Faq и возврат информации после изменений
POST api/faq/FaqsOperator	Получение типов Faq, используемых у Оператора

Fraud

Fraud controller

API	Description
POST api/fraud/ClientData	Получение детализации фрод-мониторинга по клиенту: попадания, правила, чеки
POST api/fraud/FilterData	Получение списка фильтров и их значений для таблиц сервиса фрод-мониторинга
POST api/fraud/StatusChange	Изменение статусов записи фрод-мониторинга
POST api/fraud/ActionLog	Лог действий пользователей в сервисе фрод-мониторинга
POST api/fraud/PagingInfo	Получение информации о попаданиях клиентов в систему фрод-мониторинга, с пагинацией и фильтрами
POST api/fraud/RulePagingInfo	Получение информации о созданных правилах сервиса фрод-мониторинга, с пагинацией и входными фильтрами
POST api/fraud/RuleAction	Добавление, изменение, получение информации о правиле сервиса фрод-мониторинга