Ошибки сервиса
Формат ошибок сервиса информации о ККТ и ФН по RFC 7807 и справочник типовых ошибок.
Все ошибки базируются на модели объекта сведений об ошибке RFC 7807 (Problem Details).
Формат ответа с ошибкой
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
type | string | Да | Ссылка на описание типа ошибки |
title | string | Да | Название ошибки |
status | number | Да | Код состояния HTTP |
detail | string | Нет | Описание ошибки |
instance | string | Нет | URI объекта, относительно которого возникла ошибка |
traceId | string | Да | Идентификатор ошибки (трассировки) |
errorCode | string | Нет | Символьный код ошибки |
errors | object | Нет | Коллекция ошибок валидации входной модели: ключ (поле или jsonPath) -> описание |
Типовые ошибки
errorCode | Описание | HTTP | Когда возникает |
|---|---|---|---|
WrongLoginOrPassword | Неверный логин или пароль | 401 | Передан неверный логин или пароль в методе авторизации |
MissingToken | Не распознан токен запроса | 401 | Токен не приложен к запросу или имеет неверный формат |
ExpiredToken | Переданный токен не активен | 401 | Истек срок действия токена (24 часа) |
Остальные ошибки приходят без errorCode - различайте их по status и title:
| HTTP | title | Когда возникает |
|---|---|---|
| 400 | Ошибка валидации | В запросе отсутствуют обязательные поля - состав в errors: { "<поле>": ["<описание>"] } |
| 400 | Ошибка валидации | Запрос имеет неверный формат JSON - errors: { "<jsonPath>": ["<описание>"] } |
| 403 | Forbidden | Токен не авторизует пользователя (недостаточно прав) |
| 404 | Not Found | Некорректный серийный номер ККТ |
| 500 | Ошибка сервера | Необработанная ошибка сервера |
json
{
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Переданный токен не активен",
"status": 401,
"detail": "Переданный токен не активен",
"instance": "/api/kkt/v1/cash-registers",
"traceId": "0HLR9…",
"errorCode": "ExpiredToken"
}При получении ExpiredToken запросите новый токен методом
авторизации и повторите запрос.