Каталог

Цвета для конфигурации

GET/api/{brand}/{model}/{year}/{variant}/{trim}/colors

Цвета, показанные для этого автомобиля, специально компактные: цвета дома Vehicleimagery (доступны на каждом автомобиле) плюс цвета собственного бренда этого автомобиля. Любой активный цвет каталога все еще можно запросить на любом автомобиле. Передайте имя как ?color= на конечной точке изображения. Полный каталог с парой брендов находится по адресу /api/colors; см. также руководство *Цвета краски* по адресу /info/guides/colors.

Цвета принадлежат бренду: если такая конфигурация отсутствует в каталоге (например, неизвестная комплектация), все равно возвращаются цвета бренда с id: null и vehicle_found: false. Только неизвестный бренд отвечает 404.

API v2 дополнение: для автомобиля с дополнительными изображениями в ответе также есть any_hex_color: true — его краска может быть дополнительно установлена в любой 6-значный цвет в шестнадцатеричном формате, например, ?color=c8102e

Параметры пути

Название	Тип	Описание
`brand` обязательно	строка	Название бренда или его синоним (независимо от регистра).
`model` обязательно	строка	Название модели.
`year` обязательно	целое число	Год модели (4 цифры). Если точный год отсутствует, используется ближайшая доступная генерация (ошибка `Y01`).
`variant` обязательно	строка	Вариант кузова.
`trim` обязательно	строка	Уровень обрезки.

Параметры запроса

Название	Тип	Описание
`version`	строка	Результаты только одной версии: `v1` = стандартные изображения, `v2` = дополнение API v2 (без отката к стандартным изображениям). Без него: всё, что позволяет ваш ключ. Не разрешено для вашего ключа → `403`. `v1v2`

Запрос

curl "https://api.vehicleimagery.com/api/bmw/m4/2024/coupe/base/colors?version=v1" \
  -H "x-api-key: YOUR_API_KEY"

200 · Цвета.

[
  {
    "id": 911,
    "brand": "Abarth",
    "model": "124_Spider_Abarth",
    "year": 2016,
    "variant": "Basis",
    "trim": "base",
    "resolution": "default",
    "format": "png",
    "colors": [
      "default",
      "black",
      "white",
      "blue",
      "orange",
      "wine_red"
    ]
  }
]

401 · Отсутствует или недействителен `x-api-key`.

{
  "error": "Invalid API key"
}

403 · Ограничение по плану (функция, формат или бренд не разрешен) или заблокированный запрос.

{
  "error": "Mirroring is not allowed by your plan."
}

404 · Нет данных для запрошенного пути.

{
  "error": "Brand 'Xyz' not found — check /api/brands for valid brands."
}