Запросы к API

Запросы к API осуществляются на адрес

https://vsevkassu.ru/api/v1/

Формат запроса следующий

GET|POST|PUT https://vsevkassu.ru/api/v1/{function}/{id}

GET|POST|PUT - тип HTTP запроса, GET, POST или PUT
GET - предполагает выборку данных, может быть как с передачей id для выборки одного объекта, так и без передачи id - предполагает выборку списка объектов. При выборке списка можно передавать GET-параметры, которые служат для фильтрации объектов.
POST - предполагает изменение объекта. Параметр id в этом случае является обязательным, а в теле POST-запроса передается объект в виде JSON.
PUT - предполагает создание объекта. Параметр id при этом не передается, а в теле запроса передается объект в виде JSON.

id - параметр, уникальный системный идентификатор объекта.

function - вызов определенной функции для работы с объектом. Если позволяют права, то функция предоставляет возможность выбора листинга объектов (GET без параметра id), выбор одного объекта (GET с параметром id), изменение объекта (POST с параметром id), и создание объекта (PUT без параметра id) Исключение составляет функция аутентификации, которая вызывается только с методом POST и передается объект с логином и паролем.

auth

shift Функция работы со сменами.
receipt Функция для работы с чеками.
cashbox Функция для работы с кассовыми аппаратами
cashier Функция для работы с кассирами

Основной обязательный заголовок при запросе к API, который должны включать запросы

Content-Type: application/json

Для авторизации при запросах к функциям для работы с объектами

X-Api-Key: {auth_token}

Для получения токена используется функция auth

Если при запросе к API возникает ошибка, то сервер возвращает HTTP код, отличный от 200.
В зависимости от ошибки, код может быть либо 403, либо 500, либо другой.
Также, в теле ответа возвращается JSON-объект с описанием ошибки. К примеру, при неверной авторизации, возвращается HTTP-код 401 и следующий объект:

{
    "name": "Unauthorized",
    "message": "Неверный логин или пароль",
    "code": 0,
    "status": 401
}