ProBonus Api

Система ProBonus имеет собственное API (REST JSON), которое позволяет интегрироваться с внешними системами и расширять возможности системы лояльности. Например:

1. Сайт или мобильное приложение ресторана, через которые гость может зарегистрироваться в системе лояльности и получать информацию о воем балансе и операциях.
2. Сторонние модули (бронирование, доставка) которые могут запрашивать данные по гостям из системы ProBonus и в дальнейшем использовать их в целях.
3. Внешняя маркетинговая система (CRM) которая может получать данные по гостям из системы ProBonus и в свою очередь начислять на счета гостей бонусы и/или менять уровень скидки.
4. Внешние системы отчетов и аналитики, которые могут запрашивать данные из системы лояльности ProBonus.

Пример:http://saturn.carbis.ru:6896/docs - это экземпляр сервера ProBonus, развернутый на серверах ГК «Карбис».
Админка (пользовательский интерфейс) доступен по адресу http://saturn.carbis.ru:6896
Учетные данные для входа: admin / 111

Полное описание API встроено в модуль ProBonus и доступно во вкладке ProBonus API

В данном разделе описаны основные (но не все) функции API и типовые сценарии работы с ним.

Временная информация (пока пишется документация)
API имеет методы которые позволяют обрабатывать:

• «Группы счетов» - чтение, создание, модификация
• «Аккаунты (карты)« - чтение, создание, модификация (доступны все свойства)
• «Операции» - внесение/изъятие (как групповые так и на конкретный счет)
• «Типы идентификаторов» - чтение, создание, модификация
• «Справочник скидок» - чтение скидок полученных из RK, создание/модификация составных скидок/бонусов (лестниц)
• «Отчеты» - чтение

Аутентификация возможна через токен, который можно получить в разделе «Auth». (Если время жизни токена закончилось, аутентификацию нужно повторить, либо обновить через /api/v0/auth/refresh_token.)
Для того, чтобы получить нужный «accessToken», в интерфейсе «Probonus API», нужно раскрыть на эндпоинт /api/v0/auth/login и нажать «Try it out».

Указать Логин и Пароль. Указать нужно в кавычках (вместо «string»), как показано в примере. После чего нажать на кнопку «Execute».

Ниже откроется окно «Response body» в нём указан нужный токен. Его нужно скопировать без кавычек.

Далее нужно нажать кнопку «Autorize» в шапке страницы и вставить скопированный токен, во всплывающем окне. После чего нажать дублирующую клавишу «Autorize», в этом же окне.