REST API
Обзор
API реализовано в соответствии с протоколом JSONAPI.
Все методы API, кроме Token доступны только авторизованным пользователям. Для вызова этих методов необходимо отправлять HTTP заголовок, содержащий токен JWT:
Все данные следует передавать в кодировке utf-8.
Постраничная навигация
При запросе коллекции сущностей в /GET параметрах можно передать:
Номер и размер страницы соответственно. В ответе будут возвращены дополнительные блоки:
Сортировка
При запросе коллекции сущностей в /GET параметрах можно передать:
Он представляет собой json-массив объектов с условиями сортировки:
Параметр
Описание
Возможные значение
attribute
Имя атрибута модели
direction
Направление сортировки
asc, desc
Типы данных
Доступные типы данных:
Тип
Примечание
String
Строка
Int
Целое число
Float
Дробное число. Используется разделитель точка.
Boolean
Допустимые значения "Y", "N", "" (если нет данных)
Object
Вложенная структура, в ней допустимы все перечисленные выше типы данных
Ограничение нагрузки на REST API
В REST API действует ограничение на количество запросов с одного IP в единицу времени. При превышении лимита в 1000 запросов в минуту возвращается ошибка 429:
В случае получения такого сообщения клиент должен сделать паузу на 1 минуту и уменьшить частоту запросов.
Методы API
Токен
Получить токен
POST
https://api.loymaxsc.net/token
Метод для получения авторизационного токена. Токен необходим для выполнения запросов к API. Полученный токен отправляется в заголовке запроса: Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Query Parameters
username*
string
Логин
password*
boolean
Пароль
Headers
Content-Type*
string
application/vnd.api+json или application/json
Пример запроса:
Стоит учитывать, что токен имеет ограниченный срок действия - 1 час. Если он истёк, возвращается ошибка 401, и будет необходимо получить новый токен.
Клиент
Получить список клиентов
GET
https://api.loymaxsc.net/customer
Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Получить клиента
GET
https://api.loymaxsc.net/customer/:id
Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
string
Идентификатор клиента в мастер-системе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Зарегистрировать клиента
POST
https://api.loymaxsc.net/customer
Метод для регистрации профиля клиента клиента по его идентификатору в мастер-системе. ВАЖНО: Повторный вызов запроса для уже имеющегося в базе local_id обновляет все поля. Поля, которые не передавались в запросе, будут обновлены пустыми значениями, либо значениями по умолчанию. Помимо явно перечисленных ниже параметров запрос также может содержать любые параметры, имеющиеся в решении и/или индивидуальной конфигурации пользователя платформы. Разрешено только для авторизованных пользователей с ролью API.
Headers
Authorization*
string
Bearer TOKEN
Content-Type*
string
application/json application/vnd.api+json
Request Body
local_id*
string
Идентификатор клиента в мастер-системе пользователя
full_name
string
Полное имя клиента
first_name
string
Имя
middle_name
string
Отчество
last_name
string
Фамилия (Из данных 4 полей хотя бы одно должно быть заполнено)
string
phone
string
Телефон
sex
string
Пол Допустимые значения: "M","F", "" (если нет данных)
birth_date
string
Дата рождения (в строковом формате)
country
string
Страна
city
string
Город
zip
string
Индекс
register_date*
string
Дата регистрации (в строковом формате)
Изменить клиента
PATCH
https://api.loymaxsc.net/customer/:id
Метод для изменения профиля клиента по его идентификатору в мастер-системе. ВАЖНО: Запрос обновляет все поля. Поля, которые не передавались в запросе, будут обновлены пустыми значениями, либо значениями по умолчанию. Помимо явно перечисленных ниже параметров запрос также может содержать любые параметры, имеющиеся в решении и/или индивидуальной конфигурации пользователя Платформы. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id
number
Идентификатор клиента в Мастер-системе
Headers
Authorization*
string
Bearer TOKEN
Content-Type*
string
application/json application/vnd.api+json
Request Body
local_id*
string
Идентификатор клиента в мастер-системе пользователя
full_name
string
Полное имя клиента
first_name
string
Имя
middle_name
string
Отчество
last_name
string
Фамилия (Из данных 4 полей хотя бы одно должно быть заполнено)
string
phone
string
Телефон
push-id
string
Идентификатор устройства для push-рассылок
sex
string
Пол Допустимые значения: "M", "F", "" (если нет данных)
birth_date
string
Дата рождения (в строковом формате)
country
string
Страна
city
string
Город
zip
string
Почтовый индекс
register_date*
string
Дата регистрации (в строковом формате)
Пример запроса:
Изменить подписку клиента
PATCH
https://api.loymaxsc.net/customer/:local_id/subscribe
Метод для управления подпиской клиента по его идентификатору в мастер-системе. ВАЖНО: Подписка на категории рассылок, по которым код не передан не обновляется. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
local_id*
string
Идентификатор клиента в мастер-системе пользователя
Headers
Authorization*
string
Bearer TOKEN
Content-Type*
string
application/json application/vnd.api+json
Request Body
categories*
array
Массив со списком категорий в формате Категория - статус подписки. Допустимые статусы подписки: * Y - подписан; * N - не подписан; * ND - нет данных.
Обращение к категориям рассылок производится по коду категории.
Пример запроса:
Обновить статус подписки клиента
POST
https://api.loymaxsc.net/customer/:local_id/channel
Метод для изменения статуса подписок клиента.
ВАЖНО: При вызове метода не обязательно указывать все каналы подписки, достаточно указать только те, статус активности которых у клиента поменялся. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id
number
Идентификатор клиента в Мастер-системе
Headers
Authorization*
string
Bearer TOKEN
Content-Type*
string
application/json application/vnd.api+json
Request Body
boolean
E-mail-рассылка. Допустимые значения "Y", "N", "" (если нет данных)
sms
boolean
SMS-рассылка. Допустимые значения "Y", "N", "" (если нет данных)
push
boolean
PUSH-рассылка. Допустимые значения "Y", "N", "" (если нет данных)
Получить список рассылок и кампаний, в которых участвовал клиент
GET
https://api.loymaxsc.net/customer/:id/mailing
Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
string
идентификатор пользователя в мастер-системе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Зарегистрировать устройство
POST
https://api.loymaxsc.net/customer/:local_id/device
Метод для регистрации устройства клиента. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
*
String
Идентификатор клиента в мастер-системе
Headers
Authorization*
String
Bearer TOKEN
Content-Type*
String
application/json application/vnd.api+json
device_id*
String
Уникальный идентификатор устройства
Request Body
token*
String
Токен. Указывается токен от Google, Apple или Harmony в зависимости от клиентской платформы.
platform*
String
Клиентская платформа. Возможные значения: Ios, Android, Harmony.
source_code
Number
Идентификатор источника событий
Получить список устройств
GET
https://api.loymaxsc.net/customer/:local_id/device
Метод для получения списка устройств клиента. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
String
Идентификатор клиента в мастер-системе
Headers
Authorization*
String
Bearer TOKEN
Content-Type*
String
application/json application/vnd.api+json
Удалить устройство
DELETE
https://api.loymaxsc.net/customer/:local_id/device/:token
Метод для удаления устройства клиента. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
*
String
Идентификатор клиента в мастер-системе
token*
String
Токен. Указывается токен от Google, Apple или Harmony в зависимости от клиентской платформы.
Headers
Authorization*
String
Bearer TOKEN
Content-Type*
String
application/json application/vnd.api+json
device_id*
String
Уникальный идентификатор устройства
Request Body
source_code
Number
Идентификатор источника событий
Бонусы клиента
Получить информацию о бонусах клиента по его идентификатору в мастер-системе
GET
https://api.loymaxsc.net/customer/:local_id/bonus
Метод возвращает информацию о бонусах клиента по его идентификатору в мастер-системе: - Количество активных бонусов; - Количество бонусов, которые ожидают активации; - Количество бонусов, которые ожидают деактивации; - Ближайшую дату деактивации бонусов; - Ближайшее количество деактивируемых бонусов. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
local_id*
number
Идентификатор клиента в мастер-системе пользователя
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Пример запроса:
Изменить информацию о бонусах клиента по его идентификатору в мастер-системе
PATCH
https://api.loymaxsc.net/customer/:local_id/bonus
Метод для изменения бонусов клиента по его идентификатору в мастер-системе пользователя. ВАЖНО: Запрос обновляет все поля. Поля, которые не передавались в запросе, будут обновлены пустыми значениями, либо значениями по умолчанию. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
local_id*
number
Идентификатор клиента в мастер-системе пользователя
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Пример запроса:
Чек
Получить список чеков
GET
https://api.loymaxsc.net/order
Метод для получения списка чеков (заказов/транзакций). Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Получить чек
GET
https://api.loymaxsc.net/order/:id
Метод для получения чека (заказа/транзакции) по идентификатору в мастер-системе. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
string
Идентификатор чека в мастер-системе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Зарегистрировать чек
POST
https://api.loymaxsc.net/order
Метод для регистрации чека (заказа/транзакции), либо обновления существующего чека (заказа/транзакции) по его local_id. ВАЖНО: Повторный вызов запроса для уже имеющегося в базе local_id обновляет все поля. Поля, которые не передавались в запросе, будут обновлены пустыми значениями, либо значениями по умолчанию. Помимо явно перечисленных ниже параметров запрос также может содержать любые параметры, имеющиеся в решении и/или индивидуальной конфигурации пользователя Платформы. Разрешено только для авторизованных пользователей с ролью API.
Headers
Authorization
string
Bearer TOKEN
Content-Type
string
application/json application/vnd.api+json
Request Body
local_id
string
Идентификатор чека (заказа/транзакции) в мастер-системе пользователя
client_id
string
Идентификатор клиента в мастер-системе пользователя
number
string
Номер чека (заказа/транзакции)
status_name
string
Наименование статуса заказа, транзакции
date*
string
Дата чека (заказа/транзакции) (в строковом формате)
items_cnt
number
Количество продуктов в чеке (заказе/транзакции). Речь идёт о количестве единиц
items_sum
number
Сумма чека (заказа/транзакции)
items
array
Состав чека (заказа/транзакции)
Состав чека (строка чека):
Атрибут
Тип
Назначение
local_id
String
Идентификатор строки заказа / строки транзакции в мастер-системе пользователя
client_id
String
Идентификатор клиента в мастер-системе пользователя
product_id
String
Идентификатор продукта в мастер-системе пользователя
price
Number
Стоимость продукта
cnt
Number
Количество продукта
sum
Number
Сумма по строке
Жирным обозначены обязательные поля.
Помимо явно перечисленных выше параметров строка чека также может содержать любые параметры, имеющиеся в решении и/или индивидуальной конфигурации пользователя платформы.
Пример запроса:
Изменить чек
PATCH
https://api.loymaxsc.net/order/:id
Метод для изменения чека (заказа/транзакции) по его идентификатору в мастер-системе. ВАЖНО: Запрос обновляет все поля. Поля, которые не передавались в запросе, будут обновлены пустыми значениями, либо значениями по умолчанию. Помимо явно перечисленных ниже параметров запрос также может содержать любые параметры, имеющиеся в решении и/или индивидуальной конфигурации пользователя Платформы. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
string
Идентификатор чека в мастер-системе
Headers
Authorization*
string
Bearer TOKEN
Content-Type*
string
application/json application/vnd.api+json
Request Body
local_id*
string
Идентификатор чека (заказа/транзакции) в мастер-системе пользователя
client_id
string
Идентификатор клиента в мастер-системе пользователя
number
string
Номер чека (заказа/транзакции)
status_name
string
Наименование статуса заказа, транзакции
date*
string
Дата чека (заказа/транзакции) (в строковом формате)
items_cnt
number
Количество продуктов в чеке (заказе/транзакции). Речь идёт о количестве единиц
items_sum
number
Сумма чека (заказа/транзакции)
items
array
Состав чека (заказа/транзакции)
Пример запроса:
Событие
Получить список событий
GET
https://api.loymaxsc.net/event
Метод для получения списка событий. Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type
string
application/vnd.api+json или application/json
Authorization
string
Bearer TOKEN
Получить событие
GET
https://api.loymaxsc.net/event/:id
Метод для получения события. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
string
Идентификатор события в мастер-системе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Зарегистрировать событие
POST
https://api.loymaxsc.net/event
Метод для создания нового события. Поля, которые не передавались в запросе, будут заполнены пустыми значениями, либо значениями по умолчанию. Разрешено только для авторизованных пользователей с ролью API.
Headers
Authorization*
string
Bearer TOKEN
Content-Type*
string
application/json
Request Body
client_id
number
Идентификатор клиента в информационной системе пользователя. Если идентификатор не задан, то событие считается "системным", то есть относящимся ко всем клиентам
name*
string
Имя события (текстовый идентификатор)
date*
string
Дата события (в строковом формате)
context
object
Структура, содержащая контекст события. На контекст можно ссылаться в сообщениях с помощью макросов
Пример запроса:
Изменить событие
PATCH
https://api.loymaxsc.net/event/:id
Метод для изменения события по его идентификатору в мастер-системе. ВАЖНО: Запрос обновляет все поля. Поля, которые не передавались в запросе, будут обновлены пустыми значениями, либо значениями по умолчанию. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
string
Идентификатор события в мастер-системе
Headers
Authorization*
string
Bearer TOKEN
Content-Type*
string
application/json
Request Body
client_id
string
Идентификатор клиента в информационной системе пользователя. Если идентификатор не задан, то событие считается "системным", то есть относящимся ко всем клиентам
name
string
Имя события (текстовый идентификатор)
date*
string
Дата события (в строковом формате)
context
object
Структура, содержащая контекст события. На контекст можно ссылаться в сообщениях с помощью макросов
Пример запроса:
Web-событие
Зарегистрировать web-событие
POST
https://api.loymaxsc.net/web_event
Метод для записи web-событий, таких как регистрация, авторизация в системе, просмотр карточки в МП, просмотр продуктовой категории, просмотр продукта, добавление продукта в корзину, удаление продукта из корзины, очистка корзины, завершение оформления заказа, регистрация произвольного события.
Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Request Body
client_id*
string
Идентификатор клиента в мастер-системе пользователя
source_code
string
Идентификатор источника событий
session_id*
string
Идентификатор сеанса
date*
string
Дата web-события
name*
string
Наименование web-события
category_id
string
Идентификатор продуктовой категории
product_id
string
Идентификатор продукта в мастер-системе пользователя
quantity
float
Количество единиц продукта
price
float
Стоимость продукта
container
string
Наименование контейнера в который помещено событие
Пример запроса:
Продукт
Получить список продуктов
GET
https://api.loymaxsc.net/product
Метод для получения списка продуктов. Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Получить продукт
GET
https://api.loymaxsc.net/product/:id
Метод для получения продукта. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
string
Идентификатор продукта в мастер-системе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Зарегистрировать продукт
POST
https://api.loymaxsc.net/product
Метод для создания нового продукта. ВАЖНО: Повторный вызов запроса для уже имеющегося в базе local_id обновляет все поля. Поля, которые не передавались в запросе, будут заполнены пустыми значениями, либо значениями по умолчанию. Помимо явно перечисленных ниже параметров запрос также может содержать любые параметры, имеющиеся в решении и/или индивидуальной конфигурации пользователя Платформы. Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Request Body
name*
string
Название продукта
local_id*
string
Идентификатор продукта в мастер-системе
category_id
string
Идентификатор продуктовой категории в мастер-системе
Пример запроса:
Изменить продукт
PATCH
https://api.loymaxsc.net/product/:id
Метод для изменения продукта по его идентификатору в мастер-системе. ВАЖНО: Запрос обновляет все поля. Поля, которые не передавались в запросе, будут обновлены пустыми значениями, либо значениями по умолчанию. Помимо явно перечисленных ниже параметров запрос также может содержать любые параметры, имеющиеся в решении и/или индивидуальной конфигурации пользователя Платформы. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
string
Идентификатор продукта в мастер-системе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Request Body
name*
string
Название продукта
local_id*
string
Идентификатор продукта в мастер-системе пользователя
category_id
string
Идентификатор продуктовой категории в мастер- системе пользователя
Пример запроса:
Категория продуктов
Получить список категорий продуктов
GET
https://api.loymaxsc.net/category
Метод для получения списка категорий. Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Получить продуктовую категорию
GET
https://api.loymaxsc.net/category/:id
Метод для получения продуктовой категории по её идентификатору в мастер-системе. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
string
Идентификатор категории в мастер-системе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Зарегистрировать продуктовую категорию
POST
https://api.loymaxsc.net/category
Метод для создания новой продуктовой категории. ВАЖНО: Повторный вызов запроса для уже имеющегося в базе local_id обновляет все поля. Поля, которые не передавались в запросе, будут заполнены пустыми значениями, либо значениями по умолчанию. Помимо явно перечисленных ниже параметров запрос также может содержать любые параметры, имеющиеся в решении и/или индивидуальной конфигурации пользователя Платформы. Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Request Body
name*
string
Название продуктовой категории
local_id*
string
Идентификатор категории в мастер-системе пользователя
parent_id
string
Идентификатор родительской категории в мастер-системе пользователя
Пример запроса:
Изменить категорию
PATCH
https://api.loymaxsc.net/category/:id
Метод для изменения категории по её идентификатору в мастер-системе. ВАЖНО: Запрос обновляет все поля. Поля, которые не передавались в запросе, будут обновлены пустыми значениями, либо значениями по умолчанию. Помимо явно перечисленных ниже параметров запрос также может содержать любые параметры, имеющиеся в решении и/или индивидуальной конфигурации пользователя Платформы. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
string
Идентификатор категории в мастер-системе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Request Body
name*
string
Название категории
local_id*
string
Идентификатор категории в мастер-системе пользователя
parent_id
string
Идентификатор родительской категории в мастер-системе пользователя
Пример запроса:
Коммуникация
E-mail
Получить список e-mail-рассылок
GET
https://api.loymaxsc.net/communication/email/
Метод для получения списка e-mail-рассылок. Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Получить e-mail-рассылку
GET
https://api.loymaxsc.net/communication/email/:id
Метод для получения e-mail-рассылки. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
number
Идентификатор рассылки в Платформе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Получить список участников e-mail-рассылки
GET
https://api.loymaxsc.net/communication/email/:id/customers
Метод позволяет получить список участников e-mail-рассылки. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
number
Идентификатор e-mail-рассылки
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
SMS
Получить список SMS-рассылок
GET
https://api.loymaxsc.net//communication/sms/
Метод для получения списка SMS-рассылок. Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Получить SMS-рассылку
GET
https://api.loymaxsc.net/communication/sms/:id
Метод для получения SMS-рассылки. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
number
Идентификатор рассылки в Платформе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer Token
Получить список участников SMS-рассылки
GET
https://api.loymaxsc.net/communication/sms/:id/customers
Метод позволяет получить список участников SMS-рассылки. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
number
Идентификатор SMS-рассылки
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Push
Получить список push-рассылок
GET
https://api.loymaxsc.net/communication/push/
Метод для получения списка push-рассылок. Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Получить push-рассылку
GET
https://api.loymaxsc.net/communication/push/:id
Метод для получения push-рассылки. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
number
Идентификатор рассылки в Платформе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Получить список участников push-рассылки
GET
https://api.loymaxsc.net/communication/push/:id/customers
Метод позволяет получить список участников push-рассылки. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
number
Идентификатор push-рассылки
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Зарегистрировать статус push-сообщения
POST
https://api.loymaxsc.net/communication/push/state
Метод для регистрации статуса push-сообщения. Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
String
application/vnd.api+json или application/json
Authorization*
String
Bearer TOKEN
device_id*
String
Уникальный идентификатор устройства
Request Body
*
String
state*
String
Статус push-уведомления:
Delivered - доставлено;
Read - прочитано.
message_id*
String
Идентификатор push-уведомления, который можно получить из payload.
source_code
number
Идентификатор источника событий
Опросы
Получить список опросов
GET
https://api.loymaxsc.net/communication/poll/
Метод для получения списка опросов. Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Получить опрос
GET
https://api.loymaxsc.net//communication/poll/:id
Метод для получения опроса. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
number
Идентификатор опроса в Платформе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Черный список
Получить список плохих контактов
GET
https://api.loymaxsc.net/black-list/:type
Метод для получения списка плохих контактов. Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Request Body
type*
string
Тип контактов Допустимые значения: "email", "phone"
Метка
Создать метку
POST
https://api.loymaxsc.net/customer/:id/marker/
Метод для привязки метки к указанному клиенту (если метки с таким именем нет, создаётся). Разрешено только для авторизованных пользователей с ролью API.
Headers
Authorization*
string
Bearer TOKEN
Content-Type*
string
application/vnd.api+json application/json
Request Body
name*
string
Название метки (текстовый идентификатор)
client_id*
number
Идентификатор клиента в Платформе
Пример запроса:
Получить список меток клиента
GET
https://api.loymaxsc.net/customer/:id/marker/
Метод для получения списка меток, которыми отмечен клиент, по идентификатору этого клиента. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
string
Идентификатор клиента в мастер-системе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Удалить метку
DELETE
https://api.loymaxsc.net/customer/:id/marker/
Метод для снятия метки с указанного клиента. Разрешено только для авторизованных пользователей с ролью API.
Headers
Authorization*
string
Bearer TOKEN
Content-Type*
string
application/vnd.api+json application/json
Request Body
name*
string
Название метки (текстовый идентификатор)
client_id*
number
Идентификатор клиента в Платформе
Пример запроса:
Промокоды
Получить список групп промокодов
GET
https://api.loymaxsc.net/promocode-group
Метод для получения списка групп промокодов. Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Получить информацию по группе промокодов с идентификатором
GET
https://api.loymaxsc.net/promocode-group/:id
Метод для получения информации по группе промокодов с идентификатором <id>. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
number
Идентификатор группы промокодов в Платформе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Создать новую группу промокодов
POST
https://api.loymaxsc.net/promocode-group
Метод для создания новой группы промокодов, либо обновления существующей группы промокодов по её local_id. ВАЖНО: Повторный вызов запроса для уже имеющегося в базе local_id обновляет все поля. Поля, которые не передавались в запросе, будут заполнены пустыми значениями, либо значениями по умолчанию. Помимо явно перечисленных ниже параметров запрос также может содержать любые параметры, имеющиеся в решении и/или индивидуальной конфигурации пользователя Платформы. Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Request Body
name*
string
Наименование группы промокодов
local_id*
string
Идентификатор группы промокодов в мастер-системе
Пример запроса:
Изменить группу промокодов с идентификатором
PATCH
https://api.loymaxsc.net/promocode-group/:id
Метод для изменения группы промокодов по её id в Платформе. Если требуется изменить группу по её local_id, следует использовать метод POST. ВАЖНО: Запрос обновляет все поля. Поля, которые не передавались в запросе, будут обновлены пустыми значениями, либо значениями по умолчанию. Помимо явно перечисленных ниже параметров запрос также может содержать любые параметры, имеющиеся в решении и/или индивидуальной конфигурации пользователя Платформы. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
number
Идентификатор группы промокодов в Платформе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Request Body
local_id*
string
Идентификатор группы промокодов в мастер-системе пользователя
name*
string
Наименование группы промокодов
Пример запроса:
Удалить группу промокодов с идентификатором
DELETE
https://api.loymaxsc.net/promocode-group/:id
Метод для удаления группы промокодов. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
number
Идентификатор группы промокодов в Платформе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Залить промокоды в группу с идентификатором
POST
https://api.loymaxsc.net/promocode-group/:id/codes
Метод для заливки промокодов в группу по local_id. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
local_id*
number
Идентификатор группы промокодов в мастер-системе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Пример запроса:
Справочник
Получить список справочников
GET
https://api.loymaxsc.net/dictionary
Метод для получения списка справочников с их идентификаторами. Разрешено только для пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Пример запроса:
Получить справочник
GET
https://api.loymaxsc.net/dictionary/:id
Метод для получения справочника. Разрешено только для пользователей с ролью API.
Path Parameters
id*
number
Идентификатор справочника в Платформе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Пример запроса:
Зарегистрировать справочник
POST
https://api.loymaxsc.net/dictionary
Метод для создания нового справочника. Поля, которые не передавались в запросе, будут заполнены пустыми значениями, либо значениями по умолчанию. Разрешено только для авторизованных пользователей с ролью API.
Headers
Authorization*
string
Bearer TOKEN
Content-Type*
string
application/json
Request Body
name*
string
Имя справочника
code*
string
Мнемонический код справочника
Пример запроса:
Изменить справочник
PATCH
https://api.loymaxsc.net/dictionary/:id
Метод для изменения справочника по его id в Платформе. Если требуется изменить справочник по его local_id, следует использовать метод POST. ВАЖНО: Запрос обновляет все поля. Поля, которые не передавались в запросе, будут обновлены пустыми значениями, либо значениями по умолчанию. Помимо явно перечисленных ниже параметров запрос также может содержать любые параметры, имеющиеся в решении и/или индивидуальной конфигурации пользователя Платформы. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
number
Идентификатор справочника в Платформе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Request Body
local_id*
string
Идентификатор справочника в мастер-системе пользователя
name*
string
Наименование справочника
Пример запроса:
Удалить справочник
DELETE
https://api.loymaxsc.net/dictionary/:id
Метод для удаления справочника. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
id*
number
Идентификатор справочника в Платформе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Получить список элементов справочника <pid>
GET
https://api.loymaxsc.net/dictionary/:id/item
Метод для получения списка элементов справочника. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
pid*
number
Идентификатор справочника в Платформе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Получить элемент справочника <pid>
GET
https://api.loymaxsc.net/dictionary/:pid/item/:id
Метод для получения элемента справочника. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
pid*
number
Идентификатор справочника в Платформе
id*
number
Идентификатор элемента справочника
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Зарегистрировать новый элемент справочника
POST
https://api.loymaxsc.net/dictionary/:pid/item
Метод для создания нового элемента в справочнике. Поля, которые не передавались в запросе, будут заполнены пустыми значениями, либо значениями по умолчанию. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
pid*
number
Идентификатор справочника в Платформе
Headers
Authorization*
string
Bearer TOKEN
Content-Type*
string
application/json
Request Body
name*
string
Имя справочника
code*
string
Мнемонический код справочника
Пример запроса:
Изменить элемент справочника
PATCH
https://api.loymaxsc.net/dictionary/:pid/item/:id
Метод для изменения элемента справочника по его id в Платформе. ВАЖНО: Запрос обновляет все поля. Поля, которые не передавались в запросе, будут обновлены пустыми значениями, либо значениями по умолчанию. Помимо явно перечисленных ниже параметров запрос также может содержать любые параметры, имеющиеся в решении и/или индивидуальной конфигурации пользователя Платформы. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
pid*
number
Идентификатор справочника в Платформе
id*
number
Идентификатор элемента справочника в Платформе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Request Body
name*
string
Наименование справочника
Пример запроса:
Удалить элемент справочника
DELETE
https://api.loymaxsc.net/dictionary/:pid/item/:id
Метод для удаления элемента справочника. Разрешено только для авторизованных пользователей с ролью API.
Path Parameters
pid*
number
Идентификатор справочника в Платформе
id*
number
Идентификатор элемента справочника в Платформе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Last updated