external:pro_bonus:10_probonus_api

Различия

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

Ссылка на это сравнение

Предыдущая версия справа и слева Предыдущая версия
Следующая версия
Предыдущая версия
external:pro_bonus:10_probonus_api [2026/02/13 10:04] Александр Ильинexternal:pro_bonus:10_probonus_api [2026/02/16 11:29] (текущий) – [ProBonus Api] Александр Ильин
Строка 18: Строка 18:
 {{ :external:pro_bonus:pasted:20231128-145429.png }} {{ :external:pro_bonus:pasted:20231128-145429.png }}
  
-В данном разделе описаны основные (но не все) функции API и типовые сценарии работы с ним. 
  
-**Временная информация (пока пишется документация)** 
-API имеет методы которые позволяют обрабатывать: 
-  * **"Группы счетов"** - чтение, создание, модификация 
-  * **"Аккаунты (карты)"** - чтение, создание, модификация (доступны все свойства) 
-  * **"Операции"** - внесение/изъятие (как групповые так и на конкретный счет) 
-  * **"Типы идентификаторов"** - чтение, создание, модификация 
-  * **"Справочник скидок"** - чтение скидок полученных из RK, создание/модификация составных скидок/бонусов (лестниц) 
-  * **"Отчеты"** - чтение 
  
-=====Аутентификация=====+=====Авторизация===== 
 +==== Авторизация через токен пользователя для API ====  
 +Данный способ регистрации возможен от версии ProBonus v1.2.60.297 и предназначен для интеграций с внешними системами. 
 +Токен такого пользователя не имеет ограничения использования по времени. Если токен утраченто его нужно [[external:pro_bonus:03_probonus_work:01_webadmin:01_users#пользователь_для_api|заново генерировать в админке ProBonus]] и прописать на стороне внешней системы заново. 
 +<hidden> 
 +Готовый токен сначала нужно скопировать из админки и только потом сохранить. 
 +{{ :external:pro_bonus:2026-02-13_14-49-52.png |}} 
 +Проверить работоспособность токена можно через API ProBonus. 
 +Пример: На скрине изображены 3 шага: 
 +  - На основной странице кликнуть "autorize"
 +  - В окне авторизации в поле "APIKeyHeader" ввести скопированный токен. 
 +  - В окне авторизации "autorize" 
 +После авторизации станут доступны для работы методы 
 +{{ :external:pro_bonus:2026-02-13_14-54-56_2_.png |}} 
 +</hidden> 
 + 
 + 
 +==== Авторизация через логин/пароль пользователя ====  
 +Аутентификация по данным пользователя является устаревшим, но рабочим способом взаимодействия с API. 
 +Токен такого пользователя имеет ограниченное время действия. Время действия токена можно настроить из [[external:pro_bonus:01_setup:05_server_setting|админки]]. 
 +<hidden>
 Аутентификация возможна через токен, который можно получить в разделе "Auth". (Если время жизни токена закончилось, аутентификацию нужно повторить, либо обновить через /api/v0/auth/refresh_token.) Аутентификация возможна через токен, который можно получить в разделе "Auth". (Если время жизни токена закончилось, аутентификацию нужно повторить, либо обновить через /api/v0/auth/refresh_token.)
 Для того, чтобы получить нужный "accessToken", в интерфейсе "Probonus API", нужно раскрыть на эндпоинт  /api/v0/auth/login и нажать "Try it out". Для того, чтобы получить нужный "accessToken", в интерфейсе "Probonus API", нужно раскрыть на эндпоинт  /api/v0/auth/login и нажать "Try it out".
Строка 39: Строка 50:
 Далее нужно нажать кнопку "Autorize" в шапке страницы и вставить скопированный токен, во всплывающем окне. После чего нажать дублирующую клавишу "Autorize", в этом же окне. Далее нужно нажать кнопку "Autorize" в шапке страницы и вставить скопированный токен, во всплывающем окне. После чего нажать дублирующую клавишу "Autorize", в этом же окне.
 {{ :external:pro_bonus:2024-03-04_15-25-37.png |}} {{ :external:pro_bonus:2024-03-04_15-25-37.png |}}
 +</hidden>
  
  
  
  • external/pro_bonus/10_probonus_api.1770966263.txt.gz
  • Последнее изменение: 2026/02/13 10:04
  • Александр Ильин