Авторизация

> СерверККМ V4 > REST API
Дата обновления: 12 июня 2026 г.

Методы управления доступом к API: получение токена и учётные записи пользователей.

---

GET user/token

Запрос: user/token

URL: {{HTTPRoot}}/user/token

Получение токена авторизации пользователя для вызова защищённых методов API.

Логин и пароль пользователя задается в панели управления Сервера ККМ.

Тело ответа

Успешный ответ (200 OK)

{
    "Result": {
        "tokenId": "7aa6f555-69bb-41d9-b4aa-6b4d7e7e779e",
        "expire": "99991231235959"
    },
    "Code": 0,
    "Description": "OK",
    "Success": true
}

Поле Result

Тип: Token

Token

Описание токена авторизации.

Имя поля	Тип	Назначение	Пример
tokenId	string	Токен авторизации	“7aa6f555-69bb-41d9-b4aa-6b4d7e7e779e”
expire	string	Срок действия. время в формате YYYYMMDhhmmss	“99991231235959”

Примеры ошибок

401 — Ошибка авторизации

{
    "Code": 401,
    "Description": "Ошибка авторизации",
    "Success": false
}

GET user/list

Запрос: user/list

URL: {{HTTPRoot}}/user/list

Получение списка пользователей.

Тело ответа

Успешный ответ (200 OK)

{
    "Result": [
        {
            "Id": "4e7a08cb-9e0a-42b7-b0fe-5a5a03898c61",
            "UserName": "Admin",
            "FullName": "Администратор",
            "Vatin": "",
            "Role": 0,
            "TimeTokenCreation": "2026-05-21T15:22:08.1356932+08:00",
            "TimeTokenDeletion": "0001-01-01T00:00:00"
        },
        {
            "Id": "9133144b-1f0a-486d-8345-d88eefc32756",
            "UserName": "bainov",
            "FullName": "Баинов Евгений",
            "Vatin": "123456789012",
            "Role": 0,
            "TimeTokenCreation": "2026-05-22T11:34:18.4653276+08:00",
            "TimeTokenDeletion": "0001-01-01T00:00:00"
        }
    ],
    "Code": 0,
    "Description": "OK",
    "Success": true
}

Поле Result

Тип: массив объектов User

User

Имя поля	Тип	Назначение	Пример
Id	string	идентификатор пользователя в формате GUID	“fab83a20-38fb-40ea-9fdf-6fd0befefd49”
UserName	string	Логин	“Admin”
FullName	string	Полное имя пользователя	“Администратор”
Vatin	string	ИНН пользователя	“123456790”
Role	int	код роли пользователя. Значения: 0 - Администратор, 1 - Сотрудник	0
TimeTokenCreation	datetime	время создания токена	“2026-02-14T22:52:24.2915473+08:00”
TimeTokenDeletion	datetime	время удаления токена	“0001-01-01T00:00:00”

POST user

Запрос: user

URL: {{HTTPRoot}}/user

Добавление пользователя.

Тело запроса

{
    "User": {
        "UserName": "Alex",
        "FullName": "Алексей Петров",
        "Password": "Admin",
        "Vatin": "222222",
        "Role": 1
    }
}

Поле User

Имя поля	Тип	Обяз	Назначение	Пример
UserName	string	+	Логин	“artem”
Password	string	+	Пароль	“Admin”
FullName	string	+	Полное имя пользователя	“Челпанов Артем”
Vatin	string	-	ИНН пользователя	“12345679012”
Role	int	+	код роли пользователя. Значения: 0 - Администратор, 1 - Сотрудник	0

Тело ответа

Успешный ответ (200 OK)

{
    "Code": 0,
    "Description": "OK",
    "Success": true
}

Примеры ошибок

108 — Такой логин уже занят

{
    "Code": 108,
    "Description": "Такой логин уже занят",
    "Success": false
}

DELETE user?id={id}

Запрос: user

URL: {{HTTPRoot}}/user?id={id}

Удаление пользователя

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

Параметр	Обяз	Пример	Описание
id	+	c3c72919-03af-490f-aac7-d090ade6a2d3	идентификатор пользователя

Тело ответа

Успешный ответ (200 OK)

{
    "Code": 0,
    "Description": "OK",
    "Success": true
}

Примеры ошибок

108 — Такого пользователя нет

{
    "Code": 108,
    "Description": "Такого пользователя нет",
    "Success": false
}

PUT user?id={id}

Запрос: user

URL: {{HTTPRoot}}/user?id={id}

Редактирование данных профиля пользователя .

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

Параметр	Обяз	Пример	Описание
id	+	0a732a8c-4b54-4d68-b2ba-9a47215faa3e	идентификатор пользователя

Тело запроса

{
    "user": {
        "UserName": "artyom",
        "Password": "Admin21",
        "FullName": "Челпанов Артем",
        "Vatin": "221431",
        "Role": 1
    }
}

Поле User

Имя поля	Тип	Обяз	Назначение	Пример
UserName	string	+	Логин	“Admin”
FullName	string	-	Полное имя пользователя	“Администратор”
Password	string	+	Пароль	“Admin21”
Vatin	string	-	ИНН пользователя	“123456790”
Role	int	+	код роли пользователя. Значения: 0 - Администратор, 1 - Сотрудник	0

Тело ответа

Успешный ответ (200 OK)

{
    "Code": 0,
    "Description": "OK",
    "Success": true
}

Примеры ошибок

2 — Не найден обновляемый пользователь

{
    "Code": 2,
    "Description": "Не найден обновляемый пользователь 'artyom'.",
    "Success": false
}

72 — Некорректный id

{
    "Code": 72,
    "Description": "Некорректный id",
    "Success": false
}

72 — Не указан id

{
    "Code": 72,
    "Description": "Не указан id",
    "Success": false
}