Начало работы
Введение
Каждый из режимов интеграции имеет свои особенности и наборы методов, то есть пакеты API, для использования облачных возможностей.
Необходимая лицензия — R-Keeper модуль Loyalty API. Это лицензия по подписке, которая предоставляется на месяц или год. Стоимость лицензии смотрите на сайте в разделе r_k Loyalty.
На данный момент универсальное API находится в раннем доступе. Пока продукт стабилизируется и дорабатывается, вы можете пользоваться им бесплатно. Когда он будет полностью готов, необходимо будет приобрести лицензию.
Об окончании раннего доступа мы сообщим дополнительно за месяц.
Предлагается два основных режима интеграции:
- Серверная интеграция — для подключения со стороны сервера:
- Доступ по паролю и ключу ApiKey. Для получения доступа обращайтесь за ApiKey и паролем к своему менеджеру.
- Можно ограничить допустимые IP и подсети.
- Подробнее читайте в статье Авторизация для серверной интеграции.
- Клиентская интеграция — для интеграции напрямую в сайт:
- Доступ ключу Apikey и коду из СМС. Для получения доступа обращайтесь за ApiKey к своему менеджеру.
- Необходимо указать домены, с которых будет осуществляться вход.
- Подробнее Авторизация для клиентской интеграции.
Базовый адрес для всех запросов: https://api.plazius.ru/pub
Адреса запросов имеют вид:
Например: https://api.plazius.ru/pub/b2b/v1/loyalty/orders/refund
Для начала работы с API необходимо получить доступы: ApiKey и пароль.
- Корпорацию
- Тип интеграции: Серверная или Клиентская
- Если интеграция Клиентская используется для нескольких сайтов и они не являются единым интерфейсом, укажите отдельно для каждого сайта:
- Учетные данные для подключения к SMS-центру smsc.ru для отправки проверочных SMS гостю. О подключении к SMS-центру читайте в статье Инструкция для настройки SMS-центра
- Учетные данные для подключения Recapthca v2
- Домены сайта, в которые будет встраиваться API
- Список подключаемых к сайту кодов объектов.
- Для интеграции Серверной укажите:
- IP и/или подсети, из которых будет осуществляться доступ к API
- Список подключаемых к API кодов объектов.
- Если интеграция Клиентская используется для нескольких сайтов и они не являются единым интерфейсом, укажите отдельно для каждого сайта:
В ответ служба поддержки пришлет:
- ApiKey, который необходимо использовать для всех вызовов API
- Пароль для серверной интеграции, который используется для получения токенов авторизации.
Авторизация
Перед созданием запросов необходимо пройти авторизацию. После прохождения авторизации будет выдан временный токен, у которого ограниченное время действия, указанное в секундах. Этот токен необходимо передавать во всех запросах.
Для серверной интеграции:
- Время жизни — 15 минут
- Обновлять с помощью запроса Получение токена
- Обновлять не чаще одного раза в 10 минут.
Для клиентской интеграции:
- Время жизни — 3 часа
- Обновлять с помощью запроса Получение токена
- Обновлять не чаще одного раза в 2 часа и только перед реальными запросами от клиента, а не превентивно в фоне.
Подробнее читайте в статьях Авторизация для серверной интеграции и Авторизация для клиентской интеграции.
Запросы
После авторизации можно приступать к отправке запросов. Все доступные запросы описаны в соответствующих разделах r_k Loyalty и r_k Delivery.
Для всех запросов существуют обязательные параметры:
| Заголовок | Описание | Формат | Пример значения | Обязательность |
|---|---|---|---|---|
| ApiKey | Идентификатор для доступа к API нужен во всех запросах | string | RKApi-27f7592275e24abc9ec07d2b23b15795 | Во всех запросах |
| Authorization | Авторизация для входа | string (Bearer JWT auth) | Bearer <длинный JWT токен> | Во всех запросах, кроме проверки авторизации |
| correlationid | Идентификатор запроса, всегда посылает уникальную комбинацию. Необходим для техподдержки | string (guid) | 01234567890abcdef0123456789abcde | Во всех запросах |
Готовые шаблоны
Для удобства тестирования вы можете воспользоваться готовыми шаблонами, которые постоянно обновляются:
- Импортируйте коллекции, если вы тестируете в Postman
- Импортируйте спецификацию, если вы используете визуальный редактор OpenAPI.