Ошибки при выполнении запросов к Web API

Если в ходе запроса произошла ошибка (исключение), то:

  1. Запрос вернет Http-код ответа отличный от 200.
  2. Будет возвращен специальный ответ с описанием ошибки

Пример ответа с ошибкой:

{
    "meta": {
        "status": 400,
        "error_message": "The request could not be understood by the server due to malformed syntax",
        "error": "BadRequest"
    },
    "data": {}
}
  • Поле status содержит HTTP-код ошибки (400).
  • Поле error содержит техническое название ошибки.
  • Поле error_message содержит подробное описание ошибки.
  • В разделе meta могут присутствовать дополнительные поля, поясняющие ошибку.

Всегда следует проверять параметр meta.status из ответа после выполнения запроса.

Общие ошибки API

Эта таблица содержит наиболее частые виды ошибок, которые могут быть возвращены методами API. В конкретных методах могут возникать другие ошибки, в зависимости от их предназначения.

Ошибка Код Описание
ValidationError 400 Ошибка валидации аргументов запроса. Подробности ошибки указаны в полях ответа meta.error_fields и meta.error_message
BadRequest 400 Ошибка в параметрах запроса. Подробности указаны в поле ответа meta.error_message
LookupError 400 Указанный в параметрах запроса идентификатор объекта не найден
NotAuthenticated 401 Токен авторизации неверен, просрочен или отсутствует
PermissionDeniedError 403 У токена авторизации недостаточно прав на выполнение запроса. Текст ошибки будет содержать пояснение.
Error404 404 Запрошенный в URL метод API не существует
MethodNotAllowed 405 Неверный HTTP-метод
TooManyRequests 429 Превышен лимит на количество запросов
Error500 500 Внутренняя ошибка сервиса