REST API
Review
The API is implemented according to the JSONAPI protocol.
All API methods, except Token, are available only to authorized users. To call these methods, you should send HTTP header containing JWT token:
All data should be transmitted in UTF-8 encoding.
Page navigation
When querying a collection of entities in /GET you can transmit the following parameters:
Page number and size, respectively. Additional blocks will be returned in the response:
Sorting
When querying a collection of entities in /GET parameters you can transmit:
It is json array of objects with the following sorting conditions:
Parameter
Description
Possible values
attribute
Name of model attribute
direction
Sorting direction
asc, desc
Data types
Available data types:
Type
Notes
String
Line
Number
Integer and real numbers. For real numbers the separator is a dot.
Boolean
Valid values "Y", "N", "" (if no data)
Object
Nested structure, all of the above data types are allowed in it
Load limitation on REST API
REST API has a limit on the number of requests from one IP per time unit. If the limit of 1000 requests per minute is exceeded, error 429 is returned:
In the case of such a message, the customer should pause for 1 minute and reduce the frequency of requests.
API methods
Token
Receive token
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
Query example:
Keep in mind that a token has a lifetime (1 hour). If it has expired, 401 error is returned and it will be necessary to get a new token.
Customer
Receive list of customers
GET
https://api.loymaxsc.net/customer
Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Receive customer
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
Register customer
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
Дата регистрации (в строковом формате)
Change customer
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
Дата регистрации (в строковом формате)
Query example:
Change customer subscription
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 - нет данных.
Mailing categories are queried via category code.
Query example:
Register device
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_id
Number
Идентификатор источника событий
Receive list of devices
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 device
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_id
Number
Идентификатор источника событий
Customer bonuses
Receive information about customer bonuses by his identifier in the master system
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
Query example:
Change information about customer bonuses by his identifier in the master system
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
Query example:
Receipt
Receive list of receipts
GET
https://api.loymaxsc.net/order
Метод для получения списка чеков (заказов/транзакций). Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Receive receipt
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
Register receipt
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
Состав чека (заказа/транзакции)
Receipt contents (receipt string)
Attribute
Type
Purpose
local_id
String
Order string identifier/transaction string identifier in the user master system
product_id
String
Product identifier in the user's master system
price
Number
Product’s price
cnt
Number
Quantity of product units
sum
Number
Sum of receipt line
Mandatory fields are marked in bold.
In addition to the parameters explicitly listed above, the receipt string can also contain any parameters available in the solution and/or in individual configuration of the Platform user.
Query example:
Change receipt
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
Состав чека (заказа/транзакции)
Query example:
Event
Receive list of events
GET
https://api.loymaxsc.net/event
Метод для получения списка событий. Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type
string
application/vnd.api+json или application/json
Authorization
string
Bearer TOKEN
Receive event
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
Register event
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_add*
string
Дата события (в строковом формате)
context
object
Структура, содержащая контекст события. На контекст можно ссылаться в сообщениях с помощью макросов
Query example:
Change event
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_add*
string
Дата события (в строковом формате)
context
object
Структура, содержащая контекст события. На контекст можно ссылаться в сообщениях с помощью макросов
Query example:
Product
Receive list of products
GET
https://api.loymaxsc.net/product
Метод для получения списка продуктов. Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Receive product
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
Register product
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
Идентификатор продуктовой категории в мастер-системе
Query example:
Change product
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
Идентификатор продуктовой категории в мастер- системе пользователя
Query example:
Product category
Receive list of product categories
GET
https://api.loymaxsc.net/category
Метод для получения списка категорий. Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Receive product category
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
Register product category
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
Идентификатор родительской категории в мастер-системе пользователя
Query example:
Change product category
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
Идентификатор родительской категории в мастер-системе пользователя
Query example:
Communication
E-mail
Receive list of e-mail mailings
GET
https://api.loymaxsc.net/communication/email/
Метод для получения списка e-mail-рассылок. Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Receive e-mail mailing
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
Receive list of participants of e-mail mailing
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
Receive list of SMS mailings
GET
https://api.loymaxsc.net//communication/sms/
Метод для получения списка SMS-рассылок. Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Receive SMS mailing
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
Receive list of participants of SMS mailing
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
Receive list of push mailings
GET
https://api.loymaxsc.net/communication/push/
Метод для получения списка push-рассылок. Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Receive push mailing
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
Receive list of participants of push mailing
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
Register status of push message
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_id
number
Идентификатор источника событий
Polls
Receive list of polls
GET
https://api.loymaxsc.net/communication/poll/
Метод для получения списка опросов. Разрешено только для авторизованных пользователей с ролью API.
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN
Receive poll
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
Blacklist
Receive list of bad contacts
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"
Tag
Create tag
POST
https://api.loymaxsc.net/set-marker/
Метод для привязки метки к указанному клиенту (если метки с таким именем нет, создаётся). Разрешено только для авторизованных пользователей с ролью API.
Deprecated: метод устарел и не рекомендуется для использования. Используйте POST /customer/:id/marker/
Headers
Authorization*
string
Bearer TOKEN
Content-Type*
string
application/vnd.api+json application/json
Request Body
name*
string
Название метки (текстовый идентификатор)
client_id*
number
Идентификатор клиента в Платформе
Query example:
Receive list of customer tags
GET
https://api.loymaxsc.net/client-markers/local/:id
Метод для получения списка меток, которыми отмечен клиент, по идентификатору этого клиента. Разрешено только для авторизованных пользователей с ролью API.
Deprecated: метод устарел и не рекомендуется для использования. Используйте GET /customer/:id/marker/
Path Parameters
id*
string
Идентификатор клиента в мастер-системе
Headers
Content-Type*
string
application/vnd.api+json или application/json
Authorization*
string
Bearer TOKEN