Различия

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

--- external:pro_bonus:10_probonus_api [2024/03/05 06:56] – Евгений Горносталь
+++ 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.
+  * Сайт или мобильное приложение ресторана, через которые гость может зарегистрироваться в системе лояльности и получать информацию о своём балансе и операциях.
+  * Сторонние модули (бронирование, доставка), которые могут запрашивать данные по гостям из системы ProBonus и в дальнейшем использовать их в своих целях.
+  * Внешняя маркетинговая система (CRM), которая может получать данные по гостям из системы ProBonus и, в свою очередь, начислять на счета гостей бонусы и/или менять уровень скидки.
+  * Внешние системы отчётов и аналитики, которые могут запрашивать данные из системы лояльности ProBonus.
-**Пример:**[[http://saturn.carbis.ru:6896/docs|http://saturn.carbis.ru:6896/docs]] - это экземпляр сервера ProBonus, развернутый на серверах ГК "Карбис".
+**Пример:** [[http://probonus.pro:6896/docs|http://probonus.pro:6896/docs]] — это тестовый экземпляр сервера ProBonus, развёрнутый на серверах ГК «Карбис».
-Админка (пользовательский интерфейс) доступен по адресу [[http://saturn.carbis.ru:6896|http://saturn.carbis.ru:6896]]
-Учетные данные для входа: admin / 111
-Полное описание API встроено в модуль ProBonus и доступно во вкладке ProBonus API
+Пользовательский интерфейс доступен по адресу [[http://probonus.pro:6896|http://probonus.pro:6896]].
-{{ :external:pro_bonus:pasted:20231128-145235.png }}
+Учётные данные для входа: ''admin'' / ''111''.
-{{ :external:pro_bonus:pasted:20231128-145429.png }}
-В данном разделе описаны основные (но не все) функции API и типовые сценарии работы с ним.
+Данный сервер можно использовать для тестирования запросов к API.
-**Временная информация (пока пишется документация)**
-API имеет методы которые позволяют обрабатывать:
-  * **"Группы счетов"** - чтение, создание, модификация
-  * **"Аккаунты (карты)"** - чтение, создание, модификация (доступны все свойства)
-  * **"Операции"** - внесение/изъятие (как групповые так и на конкретный счет)
-  * **"Типы идентификаторов"** - чтение, создание, модификация
-  * **"Справочник скидок"** - чтение скидок полученных из RK, создание/модификация составных скидок/бонусов (лестниц)
-  * **"Отчеты"** - чтение
-====Аутентификация====
-Аутентификация возможна через токен, который можно получить в разделе "Auth". (Если время жизни токена закончилось, аутентификацию нужно повторить, либо обновить через /api/v0/auth/refresh_token.)
-Для того, чтобы получить нужный "accessToken", в интерфейсе "Probonus API", нужно раскрыть на эндпоинт  /api/v0/auth/login и нажать "Try it out".
-{{ :external:pro_bonus:2024-03-04_15-24-45.png |}}
-Указать Логин и Пароль. Указать нужно в кавычках (вместо "string"), как показано в примере. После чего нажать на кнопку "Execute".
-{{ :external:pro_bonus:2024-03-04_17-33-32.png |}}
-Ниже откроется окно "Response body" в нём указан нужный токен. Его нужно скопировать без кавычек.
-{{ :external:pro_bonus:2024-03-04_17-42-37.png |}}
-Далее нужно нажать кнопку "Autorize" в шапке страницы и вставить скопированный токен, во всплывающем окне. После чего нажать дублирующую клавишу "Autorize", в этом же окне.
-{{ :external:pro_bonus:2024-03-04_15-25-37.png |}}
+Полное описание API встроено в модуль ProBonus и доступно на вкладке **ProBonus API**.
+{{ :external:pro_bonus:pasted:20231128-145235.png }}
+{{ :external:pro_bonus:pasted:20231128-145429.png }}