Введение

API предоставляет доступ к облачным функциям Plazius.

Каждый из режимов интеграции имеет свои особенности и наборы методов, то есть пакеты API, для использования облачных возможностей.

Для работы интеграции необходимо получить лицензию.

Необходимая лицензия — Plazius Loyalty API. Это лицензия по подписке, которая предоставляется на месяц или год.

Предлагается два основных режима интеграции:

  • Серверная интеграция — для подключения со стороны сервера (back to back):
    • Доступ по паролю и ключу ApiKey. Для получения доступа обращайтесь за ApiKey и паролем к своему менеджеру.
    • Можно ограничить допустимые IP и подсети.
    • Подробнее читайте в статье Авторизация для серверной интеграции.
  • Клиентская интеграция — для интеграции напрямую в сайт (front to back, при отсутствии своего backend):
    • Доступ ключу Apikey и коду из СМС. Для получения доступа обращайтесь за ApiKey к своему менеджеру.
    • Необходимо указать домены, с которых будет осуществляться вход.
    • Подробнее Авторизация для клиентской интеграции.

Базовый адрес для всех запросов: https://api.plazius.ru/pub

Адреса запросов имеют вид:

{базовый адрес}/{тип интеграции}/{версия API продукта}/{название продукта}/{путь к функции продукта}

Например: https://api.plazius.ru/pub/b2b/v1/loyalty/orders/refund

Для начала работы с API необходимо получить доступы: ApiKey и пароль. 

Для получения доступа к API:
  1. Заполните опросный лист по интеграции
  2. Обратитесь в службу поддержки Plazius. Создайте заявку на получение доступа к API

После рассмотрения заявки техподдержка вышлет дополнительную информацию по интеграции. После покупки лицензии на API, будут предоставлены доступы - ApiKey и пароль для серверной интеграции, который используется для получения токенов авторизации

Авторизация

Перед созданием запросов необходимо пройти авторизацию. После прохождения авторизации будет выдан временный токен, у которого ограниченное время действия, указанное в секундах. Этот токен необходимо передавать во всех запросах. 

Для серверной интеграции:

  • Время жизни — 15 минут
  • Обновлять с помощью запроса Получение токена
  • Обновлять не чаще одного раза в 10 минут.

Для клиентской интеграции:

  • Время жизни — 3 часа
  • Обновлять с помощью запроса Получение токена
  • Обновлять не чаще одного раза в 2 часа и только перед реальными запросами от клиента, а не превентивно в фоне.

Подробнее читайте в статьях Авторизация для серверной интеграции и Авторизация для клиентской интеграции.

Запросы

После авторизации можно приступать к отправке запросов. Все доступные запросы описаны в соответствующих разделах Plazius API.

Для всех запросов существуют обязательные параметры:

ЗаголовокОписаниеФорматПример значенияОбязательность
ApiKeyИдентификатор для доступа к API нужен во всех запросахstringRKApi-27f7592275e24abc9ec07d2b23b15795Во всех запросах
AuthorizationАвторизация для входа

string

(Bearer JWT auth)

Bearer <длинный JWT токен>Во всех запросах, кроме проверки авторизации
correlationidИдентификатор запроса, всегда посылает уникальную комбинацию. Необходим для техподдержкиstring (guid)01234567890abcdef0123456789abcdeВо всех запросах

Готовые шаблоны

Для удобства тестирования вы можете воспользоваться готовыми шаблонами, которые постоянно обновляются: