Ошибки

Справочник по API / Общие положения / Ошибки

Изменено: 08.04.2023 02:54

Ошибки

Каждый вызов API возвращает код состояния HTTP, отражающий характер ответа. Мы сделали все возможное, чтобы следовать соглашениям об кодах состояния HTTP.

Любой неуспешный запрос возвращает ошибку 4xx или 5xx.

Диапазон 4xx означает, что с запросом возникла проблема, например отсутствующий параметр. Диапазон 5xx означает, что с нашей стороны что-то пошло не так.

Все ответы об ошибках будут содержать объект с этими атрибутами:

Параметр	Описание
status	Статус ответа: "OK" или "FAIL"
data	Объект с данными ответа
data: name	Наименование HTTP статуса
data: message	Сообщение на выбранном языке запроса
data: code	Внутренний код ответа системы (0 - успешный ответ)
data: status	Цифровой HTTP статус ответа
data: previous	Внутренняя диагностика системы при ошибочном ответе

Пример ответа:

{
  "status": "FAIL",
  "data": {
    "name": "Not Found",
    "message": "Страница не найдена.",
    "code": 0,
    "status": 404,
    "previous": {
      "name": "Invalid Route",
      "message": "Unable to resolve the request \"\".",
      "code": 0
    }
  }
}

API e-Cont.md возвращает следующие коды состояния HTTP:

200 - OK – Request succeeded
201 - Created – A resource was created
204 - No Content – Request succeeded but there is no response body

400 - Bad Request – Invalid request parameters
401 - Unauthorized – Incorrect or missing API key
403 - Forbidden – You do not have permission to view a resource or perform an action
404 - Not Found – The specified resource could not be found
429 - Too Many Requests – You’re moving too fast! Slow down!
500 - Internal Server Error – There was a problem on our end

Пред.