Сервис artixcs-sales-rest предназначен для отображения информации о продажах в Artix Control Center.

После установки кассового сервера сервис artixcs-sales-rest запускается автоматически.

Конфигурирование сервиса

Настройка сервиса производится в конфигурационном файле application.properties, расположенном в директории /opt/artixcs-sales-rest/.

Наименование	Тип данных	Описание	Примечания
server.port	целочисленный	Порт сервиса	По умолчанию `8080`
su.artix.realtime.storage	строковый	БД для подключения	По умолчанию `mysql`
su.artix.realtime.storage.driver	строковый	Название JDBC драйвера	По умолчанию `com.mysql.jdbc.Driver`
su.artix.realtime.storage.datasource.url	строковый	URL для подключения к БД	По умолчанию `jdbc:mysql://localhost:3306/documentsAll?characterEncoding=utf8`
su.artix.realtime.storage.datasource.username	строковый	Имя пользователя	По умолчанию `netroot`
su.artix.realtime.storage.datasource.password	строковый	Пароль	По умолчанию `netroot`
su.artix.report.storage	строковый	БД для подключения	По умолчанию `mysql`
su.artix.report.storage.driver	строковый	Название JDBC драйвера	По умолчанию `com.mysql.jdbc.Driver`
su.artix.report.storage.datasource.url	строковый	URL для подключения к БД	По умолчанию `jdbc:mysql://${mysql.host:localhost}:3306/documentsAll?characterEncoding=utf8`
su.artix.report.storage.datasource.username	строковый	Имя пользователя	По умолчанию `netroot`
su.artix.report.storage.datasource.password	строковый	Пароль	По умолчанию `netroot`
serviceName	строковый	Название сервиса	По умолчанию artixcs-sales-rest

По умолчанию используется БД MySQL, при необходимости можно использовать PostgreSQL.

server.port=8088
spring.jackson.date-format=su.artix.sales.rest.v1.RFC3339DateFormat
spring.jackson.serialization.WRITE_DATES_AS_TIMESTAMPS=false
logging.config=classpath:logback.xml

# realtime connection(mysql, postgresql)
su.artix.realtime.storage=mysql
su.artix.realtime.storage.driver=com.mysql.jdbc.Driver
su.artix.realtime.storage.datasource.url=jdbc:mysql://localhost:3306/documentsAll?characterEncoding=utf8
su.artix.realtime.storage.datasource.username=netroot
su.artix.realtime.storage.datasource.password=netroot

# report connection (mysql,postgresql)
su.artix.report.storage=mysql
su.artix.report.storage.driver=com.mysql.jdbc.Driver
su.artix.report.storage.datasource.url=jdbc:mysql://${mysql.host:localhost}:3306/documentsAll?characterEncoding=utf8
su.artix.report.storage.datasource.username=netroot
su.artix.report.storage.datasource.password=netroot

# url и драйвер для разных БД. отсюда можно скопировать и перенести в основные настройки
### MYSQL ###
#driver=com.mysql.jdbc.Driver
#url=jdbc:mysql://localhost:3306/documentsAll?characterEncoding=utf8
### POSTGRES ###
#driver=org.postgresql.Driver
#url=jdbc:postgresql://${postgresql.host:localhost}:5432/documents?characterEncoding=utf8
serviceName=artixcs-sales-rest

API сервиса artixcs-sales-rest

Полный список всех возможных запросов может быть получен в Swagger UI.

Описание запросов для работы с сервисом artixcs-sales-rest доступно по ссылке:

http://<IP адрес сервиса>:8088/swagger-ui/index.html

Получение документа по идентификатору

Для получения документа надо выполнить GET запрос на URL:

/v1/documents/by/id/{id}

Параметры запроса:

Наименование	Тип данных	Описание	Примечания
id	integer	Идентификационный номер документа	Обязательное поле. По умолчанию не указан

Получение списка документов по идентификаторам

Для получения списка документов по идентификационным номерам нужно выполнить запрос типа POST на URL:

/v1/documents/search

Тело запроса:

{
    "filter": {
        "docType": {
            "objectType": "LONG",
            "from": 1,
            "to": 1
        },
        "documentIds": {
            "objectType": "STRING",
            "values": [
                168,
                169
            ]
        }
    }
}

Результатом запроса является массив объектов, содержащих информацию о запрошенных документах.

[
    {
        "workshiftid": "27",
        "shopcode": null,
        "shiftnum": 22,
        "time_beg": null,
        "storeId": "_shop_1_d5b14fe1",
        "documentid": "168",
        "cashcode": "1",
        "checknum": "1",
        "timeOpen": "2026-06-25T16:03:03.000+0000",
        "timeClose": "2026-06-25T16:12:10.000+0000",
        "identifier": "00010100220000001160303",
        "docSum": 100.00,
        "doctype": 1,
        "cashType": "POS",
        "fiscalDocuments": [],
        "username": "Оператор-кассир"
    },
    {
        "workshiftid": "28",
        "shopcode": null,
        "shiftnum": 1,
        "time_beg": null,
        "storeId": "_shop_2_001da07c",
        "documentid": "169",
        "cashcode": "3",
        "checknum": "1",
        "timeOpen": "2026-02-11T04:43:02.000+0000",
        "timeClose": "2026-02-11T04:43:09.000+0000",
        "identifier": "00010300010000001044302",
        "docSum": 70.90,
        "doctype": 1,
        "cashType": "SSCO",
        "fiscalDocuments": [],
        "username": "Мастер"
    }
]