Публичное пространство
SetMoby ◾️Справочник API SetMobyApi
- 1 Описание
- 2 Авторизация
- 3 SetMobyAPI
- 3.1 Проверка подключения к серверу (check)
- 3.1.1 Параметры
- 3.1.2 Пример запроса (Request body)
- 3.1.3 Ответ
- 3.2 Загрузка/обновление справочника товаров (goods)
- 3.2.1 Параметры
- 3.2.1.1 Параметры товара (goods)
- 3.2.1.2 Параметры штрихкода (barcodes)
- 3.2.1.3 Параметры производителя (producer)
- 3.2.2 Пример запроса (Request body)
- 3.2.3 Ответ
- 3.2.1 Параметры
- 3.3 Загрузка/обновление справочника магазинов (shop)
- 3.3.1 Параметры
- 3.3.1.1 Параметры магазина (shop)
- 3.3.2 Пример запроса (Request body)
- 3.3.3 Ответ
- 3.3.1 Параметры
- 3.4 Работа с документами (document_api)
- 3.4.1 PUT/POST
- 3.4.1.1 Параметры
- 3.4.1.1.1 Параметры поставщика (contractor)
- 3.4.1.1.2 Параметры списка товаров (positions)
- 3.4.1.1.3 Параметры списка коробок с алкогольным товаром (boxList)
- 3.4.1.1.4 Параметры списка паллет (boxTree)
- 3.4.1.2 Примеры запросов документов (Request body)
- 3.4.1.2.1 Пример запроса документа приемки
- 3.4.1.2.2 Пример запроса документа инвентаризации
- 3.4.1.2.3 Пример запроса документа приемки ЕГАИС
- 3.4.1.2.4 Пример запроса документа инвентаризации ЕГАИС
- 3.4.1.2.5 Пример запроса документ сборки заказа
- 3.4.1.3 Ответ для PUT/POST
- 3.4.1.1 Параметры
- 3.4.2 DELETE
- 3.4.2.1 Параметры
- 3.4.2.2 Пример запроса (Request body)
- 3.4.2.3 Ответ
- 3.4.3 GET
- 3.4.3.1 Параметры
- 3.4.3.2 Пример запроса (Request body)
- 3.4.3.3 Ответ
- 3.4.1 PUT/POST
- 3.1 Проверка подключения к серверу (check)
Описание
В качестве API в нашей системе используется REST API, объединяющий самые распространенные методы обработки данных посредством HTTP-запросов (GET, POST, PUT, DELETE).
Авторизация
Чтобы начать работу с SetMobyApi, необходимо пройти процедуру авторизации. Используется схема базовой аутентификации (Basic Auth).
Это механизм, при котором имя пользователя и пароль отправляются прямо в заголовке HTTP-запроса, но предварительно кодируются методом Base64. Таким образом, хотя данные передаются открыто, они выглядят зашифрованными для обычного просмотра.
Пример заголовка Basic Auth выглядит так:
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Где dXNlcm5hbWU6cGFzc3dvcmQ=
— это имя пользователя (username
) и пароль (password
), закодированные в Base64.
Для получения учетных данных (имени пользователя и пароля) обратитесь к вашему персональному менеджеру CSI. В результате вам будут предоставлены стандартные логин и пароль, которые по умолчанию используются для авторизации.
SetMobyAPI
SetMobyApi включает ресурсы:
check — проверка подключения к серверу.
goods — загрузка/обновление справочника товаров.
shop — загрузка/обновление справочника магазинов.
document_api — работа с документами (создание, изменение, удаление, получение).
Данные передаются внутри тела запроса в формате JSON.
Проверка подключения к серверу (check)
Метод | Путь к методу (endpoint) | Описание |
---|---|---|
GET | /api/cheсkConnection | Возвращает статус подключения к серверу SetMoby |
Параметры
Нет параметров.
Пример запроса (Request body)
Curl
curl -X 'GET' \
'http://172.29.21.221:8088/api/checkConnection' \
-H 'accept: */*'
Request URL
http://172.29.21.221:8088/api/checkConnection
Ответ
Код статуса | Описание |
---|---|
200 | Запрос подключения выполнен успешно |
401 | Неверный логин или пароль |
Загрузка/обновление справочника товаров (goods)
Метод | Путь к методу (endpoint) | Описание |
---|---|---|
POST | /api/goods | Загрузка/обновление справочника товаров |
Параметры
Параметр | Тип данных | Описание | Обязательность | Пример значения |
---|---|---|---|---|
| string | Версия структуры JSON | Да |
|
| array | Товар | Да | — |
Параметры товара (goods)
Если загружаете новые товары, то их
id
должны быть уникальными.Если обновляете данные ранее загруженных товаров, заполните только те параметры, которые необходимо изменить. Параметр
id
при обновлении товара не меняйте.
Параметр | Тип данных | Описание | Обязательность | Пример значения |
---|---|---|---|---|
| string | Уникальный идентификатор товара в ERP | Да |
|
| string | Артикул товара | Нет |
|
| string | Наименование товара | Да |
|
| boolean | Признак ввода даты производства | Нет |
|
| boolean | Признак ввода срока годности | Нет |
|
| boolean | Признак проверки марки ЧЗ | Нет |
|
| string | Базовая единица измерения | Нет |
|
| number | Цена товара | Нет |
|
| array | Параметры штрихкода (barcodes) Штрихкод добавляемого товара | Да | — |
| object | Нет | — |
Параметры штрихкода (barcodes)
Параметр | Тип данных | Описание | Обязательность | Пример значения |
| string | Штрихкод товара | Да |
|
| number | Количество товара с этим штрихкодом | Да |
|
Параметры производителя (producer)
Параметр | Тип данных | Описание | Обязательность | Пример значения |
| string | Наименование производителя | Да |
|
Пример запроса (Request body)
Указанный ниже пример запроса соответствует актуальной версии API 01.0 с обязательным параметром version
. Также поддерживается старый вариант запроса без параметра version
.
{
"version": "01.0",
"goods": [
{
"id": "0b90ed69-26a4-11e8-816a-0050569579f0",
"item": "0132061",
"name": "Мороженое \"ВАРЯ с соленой карамелью\" БЗМЖ, 500г (Контейнер)",
"checkDateMake": false,
"checkDateBefore": true,
"checkMark": true,
"salePrice": 325.99,
"unit": "шт",
"barcodes": [
{
"barcode": "4610083912686",
"quantity": 1
}
],
"producer": {
"name": "ООО \"Петрохолод\""
}
}
]
}
Ответ
Код статуса | Описание |
---|---|
200 | Успешно загружен/обновлен справочник товаров |
500 | Структура запроса не соответствует требуемой JSON-схеме/ ошибка в работе базы данных |
400 | Ошибка в типе данных/ отсутствуют обязательные параметры |
401 | Неверный логин или пароль |
Загрузка/обновление справочника магазинов (shop)
Метод | Путь к методу (endpoint) | Описание |
---|---|---|
POST | /api/shops | Загрузка/обновление справочника магазинов |
Параметры
Параметр | Тип данных | Описание | Обязательность | Пример значения |
---|---|---|---|---|
| string | Версия структуры JSON | Да |
|
| array | Список магазинов, которые необходимо загрузить | Да | — |
Параметры магазина (shop)
Параметр
number
является необязательным, если его не указать, система присвоит номер магазина автоматически.Если загружаете новые магазины, то их
id
должны быть уникальными.Если обновляете данные ранее загруженных магазинов, заполните только те параметры, которые необходимо изменить. Параметр
id
при обновлении магазина не меняйте.
Параметр | Тип данных | Описание | Обязательность | Пример значения |
---|---|---|---|---|
| string | Уникальный идентификатор магазина | Да |
|
| integer | Номер магазина | Нет |
|
| string | Наименование магазина | Да |
|
| string | Адрес магазина | Нет |
|
Пример запроса (Request body)
Указанный ниже пример запроса соответствует актуальной версии API 01.0 с обязательным параметром version
. Также поддерживается старый вариант запроса без параметра version
.
{
"version": "01.0",
"shops": [
{
"id": "0b90ed69-26a4-11e8-816a-0050569579f0",
"number": 123,
"name": "ТК-123",
"address": "СПб, Чкаловский 52"
}
]
}
Ответ
Код статуса | Описание |
---|---|
200 | Успешно загружен/обновлен справочник магазинов |
500 | Структура запроса не соответствует требуемой JSON-схеме/ ошибка в работе базы данных |
400 | Ошибка в типе данных/ отсутствуют обязательные параметры |
401 | Неверный логин или пароль |
Работа с документами (document_api)
PUT/POST
Параметры
Если загружаете новые документы, то их
id
должны быть уникальными.Если обновляете данные ранее загруженных документов, заполните только те параметры, которые необходимо изменить. Параметр
id
при обновлении документа не меняйте.
Параметр | Тип данных | Описание | Обязательность | Пример значения |
---|---|---|---|---|
| string | Версия структуры JSON | Да |
|
| string | Идентификатор документа в ERP | Да |
|
| object | Магазин | Да | — |
| object | Поставщик | Да | — |
| string | Номер документа | Да |
|
| string | Тип документа | Да |
|
| string | Время создания документа | Да |
|
| array | Список товаров, которые необходимо загрузить | Да | — |
Параметры поставщика (contractor)
Параметр | Тип данных | Описание | Обязательность | Пример значения |
| string | Идентификатор контрагента | Да |
|
| string | Наименование контрагента | Да |
|
Параметры списка товаров (positions)
Параметр | Тип данных | Описание | Обязательность | Пример значения |
| integer | Номер позиции в документе | Да |
|
| number | Количество по плану | Да |
|
| number | Количество по факту | Нет |
|
| object | Список товаров, которые необходимо загрузить | Да |
|
| string | Базовая единица измерения | Нет |
|
| array of strings | Список марок ЧЗ | Обязательно только для марок |
|
| array of strings | Список коробок с алкогольным товаром | Обязательно только для марок ЕГАИС |
|
| array | Список паллет | Обязательно только для марок ЕГАИС | — |
| string | Дата производства | Нет |
|
| string | Срок годности | Нет |
|
Параметры списка коробок с алкогольным товаром (boxList)
Параметр | Тип данных | Описание | Обязательность | Пример значения |
| string | Номер коробки (упаковки) или пустая строка | Обязательно только для марок ЕГАИС |
|
| array of strings | Массив марок | Обязательно только для марок ЕГАИС |
|
Параметры списка паллет (boxTree)
Параметр | Тип данных | Описание | Обязательность | Пример значения |
| string | Номер паллеты (или пустая строка) | Обязательно только для марок ЕГАИС |
|
| array of strings | Массив коробок (упаковок) | Обязательно только для марок ЕГАИС |
|
Примеры запросов документов (Request body)
Пример запроса документа приемки
Пример запроса документа инвентаризации
Пример запроса документа приемки ЕГАИС
Пример запроса документа инвентаризации ЕГАИС
Пример запроса документ сборки заказа
Ответ для PUT/POST
Код статуса | Описание |
---|---|
200 (PUT) | Успешно изменены документы |
200 (POST) | Успешно созданы новые документы |
403 | Документ завершен |
409 | Документ в работе |
404 | Документ не найден |
500 | Структура запроса не соответствует требуемой JSON-схеме/ ошибка в работе базы данных |
400 | Ошибка в типе данных/ отсутствуют обязательные параметры |
401 | Неверный логин или пароль |
DELETE
Параметры
Параметр | Тип данных | Описание | Обязательность | Пример значения |
---|---|---|---|---|
| string | Идентификатор документа в ERP | Запрос можно выполнять одним из способов:
|
|
| string | Номер магазина |
| |
| string | Тип документа |
| |
| string | Номер документа |
|
Пример запроса (Request body)
© 1994-2025, ООО «Кристалл Сервис Интеграция».
Все права защищены.