Обращение к методам API

Стандартные коды ответов

Ниже перечислены стандартные типы ответов, которые необходимо учитывать при работе.

  • 400 Bad Request Некорректный запрос. Если тело запроса содержит некорректную, не полную или не соответствующую формату метода информацию.
  • 401 Bad Request Не авторизован. Этот код ответа можно получить в том случае, если не был передан токен.
  • 403 Forbidden Запрещено. В результате выполнения API произошла попытка работы с данными, к которым у пользователя/DMS нет доступа.
  • 404 Not Found Не найдено. Запрашиваемый ресурс не найден.
  • 405 Method Not Allowed Метод не поддерживается.
  • 409 Conflict Конфликт. Конфликт с текущим состоянием объекта, объект уже был изменен.
  • 409 Conflict Конфликт. Не включен источник стока DMS в настройках автосалона.
  • 428 Precondition Required Проблема Lost Update, требуется If-Match заголовок.
  • 429 Too Many Requests Превышена частота запросов.
  • 500 Internal Server Error Ошибка. При выполнении запроса произошла исключительная ситуация, проблема на стороне API, этой ошибки не должно быть, если она повторяется сообщите о ней на help@business.auto.ru.
  • 200 OK Запрос успешно обработан
  • 201 Created Ресурс успешно создан

Если DMS.API отвечает 4XX кодом, то в теле ответа может прийти описание ошибки в следующем формате:


        {
        "message": "Some troubles here",
        "code": 12
        }

Используйте эту информацию, когда обращаетесь к нам, чтобы решить проблему как можно быстрее.

  • 200 OK Запрос выполнен успешно.
  • 400 Bad Request Ошибка входных данных.
  • 401 Bad Request Не авторизован. Этот код ответа можно получить в том случае, если не был передан токен.
  • 404 Not Found Невозможно расшифровать VIN.
  • 422 Unprocessable Entity Мало данных для предоставления статистики или тип транспортного средства не легковой.
  • 429 Too Many Requests Сервис перегружен, повторите попытку немного позже.
  • 500 Internal Server Error Внутренняя ошибка. При выполнении запроса произошла исключительная ситуация, проблема на стороне API, этой ошибки не должно быть, если она повторяется сообщите о ней на help@business.auto.ru.

Заголовок User-Agent (DMS.API)

Каждый запрос должен содержать заголовок User-Agent с названием приложения-клиента и контактным адресом электронной почты для связи в случае проблем при обработке:

User-Agent: Loading stock cars daemon (tech@dealer.example.com)

Пакетная передача

Если необходимо множество отдельных запросов к API объединить в одну логическую группу, можно отправлять заголовок X-Batch-Id:

X-Batch-Id: 3451

В качестве значения принимается целое положительное число. Может использоваться в качестве группировки результатов загрузки в интерфейсе Авто.ру Бизнес.

Ограничение Rate Limit

Каждый ответ от API может содержать три заголовка:

  • X-Rate-Limit-Limit: максимальное количество запросов, в час.
  • X-Rate-Limit-Remaining: оставшееся количество запросов в текущем периоде времени.
  • X-Rate-Limit-Reset: количество секунд, которое нужно подождать до получения максимального количества запросов.

В случае, если будет превышен лимит, API вернет 429 Too Many Requests. Клиент должен уметь корректно обрабатывать эти заголовки, чтобы исключить ситуацию превышения количества запросов.

Например, X-Rate-Limit-Limit: 18000, означает, что можно делать не быстрее, чем 5 запросов в секунду.

Примечание

Актуальные ограничения по количеству запросов указаны в правилах предоставления удаленного доступа к программному продукту «Авто.ру Бизнес».

Предыдущая
Авторизация в API Авто.ру Бизнес
Следующая
Автокаталог