Различия

Показаны различия между двумя версиями страницы.

--- external:pro_bonus:10_probonus_api [2023/12/08 12:38] – Евгений Агеев
+++ external:pro_bonus:10_probonus_api [2026/10/22 10:07] (текущий) – «в целях» → «в своих целях» Алексей Коробов
@@ Строка 1: / Строка 1: @@
-====== ProBonus Api ======
+====== ProBonus API ======
 Система ProBonus имеет собственное API (REST JSON), которое позволяет интегрироваться с внешними системами и расширять возможности системы лояльности. Например:
-  - Сайт или мобильное приложение ресторана, через которые гость может зарегистрироваться в системе лояльности и получать информацию о воем балансе и операциях.
-  - Сторонние модули (бронирование, доставка) которые могут запрашивать данные по гостям из системы ProBonus и в дальнейшем использовать их в целях.
-  - Внешняя маркетинговая система (CRM) которая может получать данные по гостям из системы ProBonus и в свою очередь начислять на счета гостей бонусы и/или менять уровень скидки.
-  - Внешние системы отчетов и аналитики, которые могут запрашивать данные из системы лояльности ProBonus.
-Полное описание API встроено в модуль ProBonus и доступно во вкладке ProBonus API
+  * Сайт или мобильное приложение ресторана, через которые гость может зарегистрироваться в системе лояльности и получать информацию о своём балансе и операциях.
-{{ :external:pro_bonus:pasted:20231128-145235.png }}
+  * Сторонние модули (бронирование, доставка), которые могут запрашивать данные по гостям из системы ProBonus и в дальнейшем использовать их в своих целях.
-{{ :external:pro_bonus:pasted:20231128-145429.png }}
+  * Внешняя маркетинговая система (CRM), которая может получать данные по гостям из системы ProBonus и, в свою очередь, начислять на счета гостей бонусы и/или менять уровень скидки.
+  * Внешние системы отчётов и аналитики, которые могут запрашивать данные из системы лояльности ProBonus.
-**Пример:**[[https://saturn.carbis.ru:6896/docs|https://saturn.carbis.ru:6896/docs] - это экземпляр сервера ProBonus, развернутый на серверах ГК "Карбис".
+**Пример:** [[http://probonus.pro:6896/docs|http://probonus.pro:6896/docs]] — это тестовый экземпляр сервера ProBonus, развёрнутый на серверах ГК «Карбис».
-Админка (пользовательский интерфейс) доступен по адресу [[https://saturn.carbis.ru:6896|https://saturn.carbis.ru:6896]]
-Учетные данные для входа: admin / 111
-В данном разделе описаны основные (но не все) функции API и типовые сценарии работы с ним.
+Пользовательский интерфейс доступен по адресу [[http://probonus.pro:6896|http://probonus.pro:6896]].
+Учётные данные для входа: ''admin'' / ''111''.
+Данный сервер можно использовать для тестирования запросов к API.
+Полное описание API встроено в модуль ProBonus и доступно на вкладке **ProBonus API**.
+{{ :external:pro_bonus:pasted:20231128-145235.png }}
+{{ :external:pro_bonus:pasted:20231128-145429.png }}
-**Временная информация (пока пишется документация)**
-API имеет методы которые позволяют обрабатывать:
-  * **"Группы счетов"** - чтение, создание, модификация
-  * **"Аккаунты (карты)"** - чтение, создание, модификация (доступны все свойства)
-  * **"Операции"** - внесение/изъятие (как групповые так и на конкретный счет)
-  * **"Типы идентификаторов"** - чтение, создание, модификация
-  * **"Справочник скидок"** - чтение скидок полученных из RK, создание/модификация составных скидок/бонусов (лестниц)
-  * **"Отчеты"** - чтение