Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия |
external:pro_bonus:10_probonus_api [2023/08/18 08:45] – Алексей Коробов | external:pro_bonus:10_probonus_api [2024/12/16 15:24] (текущий) – Алексей Коробов |
---|
- Внешние системы отчетов и аналитики, которые могут запрашивать данные из системы лояльности ProBonus. | - Внешние системы отчетов и аналитики, которые могут запрашивать данные из системы лояльности ProBonus. |
| |
Полное описание API встроено в модуль ProBonus и доступно по ссылке http://127.0.0.1:11030/docs | |
где **127.0.0.1:11030** - стандартный адрес/порт сервера ProBonus, а **/docs** - страница с документацией к API. | |
| |
Пример: http://saturn.carbis.ru:6896/docs - это экземпляр сервера ProBonus, развернутый на серверах ГК "Карбис". | **Пример:**[[http://probonus.pro:6896/docs|http://probonus.pro:6896/docs]] - это экземпляр сервера ProBonus, развернутый на серверах ГК "Карбис". |
Админка (пользовательский интерфейс) доступен по адресу http://saturn.carbis.ru:6896 | Админка (пользовательский интерфейс) доступен по адресу [[http://probonus.pro:6896|http://probonus.pro:6896]] |
Учетные данные для входа: admin / 111 | Учетные данные для входа: admin / 111 |
| |
| Полное описание API встроено в модуль ProBonus и доступно во вкладке ProBonus API |
| |
| {{ :external:pro_bonus:pasted:20231128-145235.png }} |
| {{ :external:pro_bonus:pasted:20231128-145429.png }} |
| |
В данном разделе описаны основные (но не все) функции API и типовые сценарии работы с ним. | В данном разделе описаны основные (но не все) функции API и типовые сценарии работы с ним. |
* **"Справочник скидок"** - чтение скидок полученных из RK, создание/модификация составных скидок/бонусов (лестниц) | * **"Справочник скидок"** - чтение скидок полученных из 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 |}} |
| |
| |
| |
| |