Ошибки обработки запросов

• Ошибки Global
• Ошибки Security
• Ошибки Billing
• Ошибки Data

Если запрос обработан успешно, API вернёт HTTP-код 200 и тело ответа.

Если при обработке запроса возникает ошибка, API возвращает HTTP-код ошибки и её описание в теле ответа.

Структура ответа

{
  "state": "fail",
  "version": "2.0",
  "stamp": "2021-09-03T12:35:58.430Z",
  "event": {
    "uid": "",
    "stamp": "2021-09-03T12:35:58.430Z",
    "code": "B011",
    "cls": "Billing",
    "type": "NoQuoteDay",
    "name": "Переполнение дневной квоты указанного типа отчета",
    "message": "Превышена дневная квота (2 ед.) на генерацию отчета test_report_type2@test_domain",
    "data": {
      "report_type": "test_report_type2@test_domain",
      "day_quote": "2"
    },
    "events": []
  }
}

Ошибки Global

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

Ошибки Security

Ошибки этого класса возвращаются, если запрос нарушает требования безопасности: например, при отсутствии прав на доступ к запрашиваемым данным, передаче неправильно сформированного токена или неверных аутентификационных данных.

Ошибки Billing

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

Ошибки Data

Такие ошибки могут быть получены, если запрошены несуществующие данные или запрос содержит некорректные параметры.