Общее

API основано на архитектуре REST и может принимать и возвращать результаты запросов в двух форматах: json и xml. Для того, чтобы получить ответ от сервера в определённом формате, к пути ресурса через точку необходимо добавить его формат [путь_к_ресурсу].[формат] (например, /v1/orders.json) Если в пути ресурса формат не указан, ответ будет возвращён в формате по умолчанию — json.

Версионирование

С течением времени могут измениться как перечень запросов, так их структура и структура ответов. Для уверенности в том, что используется API желаемой версии, необходимо передавать версию в строке запроса. Итого запрос должен выглядеть следующим образом: /v[версия]/[путь_к_ресурсу]

Пример

  GET https://api.v-avto.ru/v1/orders.json?key=393-QBjhK44xUrbgduYHdANoLWdZx8eiPKCUQDvxU2v6MdiPnadQzLUBpYBHWKkg7gGYj9VcMyYif55Qd3g5

Перечень версий

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

При возникновении ошибки, возвращается объект errors, при успешном ответе, сервер возвращает данные в объекте response

JSON

  {
    "response" : {
      ... тело ответа ...
    }
  }

JSON

  <?xml version="1.0" encoding="UTF-8"?>
  <response>
    ... тело ответа ...
  </response>