Дополнение API v2
Сцены из жизни: определить изображение
GET/api/{brand}/{model}/{year}/{variant}/{trim}/lifestyle/{scene}/{image}
Дополнение API v2 — ключи с доступом v2. Одно образцовое изображение с подписанным image_url. Образцовые изображения — это полные сцены: они всегда заполняют кадр (fit=cover), фон (background) не применяется (ошибка B32). Краска (color), lights, size, ratio и format работают так же, как и везде.
Параметры пути
| Название | Тип | Описание |
|---|---|---|
brand обязательно | строка | Название бренда (обновленное наименование каталога для автомобилей с дополнением). |
model обязательно | строка | Название модели. |
year обязательно | целое число | Год модели (4 цифры). Если точный год отсутствует, используется ближайшая доступная генерация (ошибка `Y01`). |
variant обязательно | строка | Вариант кузова. |
trim обязательно | строка | Уровень обрезки. |
scene обязательно | строка | Сцена. |
image обязательно | строка | Изображение сцены (см. *Lifestyle: изображения сцены*). |
Параметры запроса
| Название | Тип | Описание |
|---|---|---|
format | строка | Формат доставки. pngwebpjpegavifauto |
ratio | строка | Соотношение сторон (обрезано для заполнения). 1:14:33:216:916:102:121:95:43:44:52:39:16 |
color | строка | Краска: название цвета каталога, 6-значный HEX или `<finish>_<hex>` (например, `metallic_315fbf`). |
color_id | целое число | Цвет краски по его id из `/api/colors`. Используйте его, когда имя существует более одного раза: id уникален и никогда не меняется. Имеет приоритет над `color`; `0` — оригинальная краска. Неизвестный или неактивный id → как неизвестное имя (цвет по умолчанию + ошибка `F04`). |
lights | строка | **Дополнение API v2:** фары включены или выключены. **По умолчанию `включены`:** без параметра изображение приходит с включенными фарами, где бы они ни были; отправьте `lights=off`, чтобы получить изображение без фар. Изображение без варианта с фарами просто приходит без них; с `lights=on` оно также несет ошибку `L26`. onoff |
windows | строка | **Дополнение к API v2:** `see_through` = стекло, как на изображении (по умолчанию), `dark` = тонированное стекло, через которое нельзя видеть. Недоступно → ошибка `W28`. see_throughdark |
plate | строка | **API v2 дополнение:** номерной знак — `none` = как на изображении (по умолчанию), `blank` = пустой номер, `logo` = ваш логотип на номере (настроен на вашем ключе; отсутствует → пустой + ошибка `N30`), `text` = ваш собственный текст из `plate_text` (должен быть включен для вашего ключа, см. `addon.plate_text` в `/api/me`; в противном случае ошибка `O31`). noneblanklogotext |
plate_text | строка | **API v2 дополнение:** текст для `plate=text` — до 10 символов: буквы, цифры, пробелы и `-` `.` `&`. Написан на номере так, как отправлено (верхний и нижний регистр сохраняется), по центру и максимально крупно, насколько позволяет номер. Отсутствует, слишком длинный или другие символы → `400`. |
size | строка | **Дополнение к API v2:** наибольшая сторона — `2k` 2560 px, `1080p` 1920 px, `720p` 1280 px, `540p` 960 px, `360p` 640 px, `thumb` 320 px. `width` / `height` переопределяют `size`. 2k1080p720p540p360pthumb |
hotspots | строка | **Дополнение к API v2:** добавьте `hotspots` в ответ — точки интереса (диски, фары и т.д.) в виде дробей 0–1 от изображения, например, для интерактивных просмотров. true |
version | строка | Результаты только одной версии: `v1` = стандартные изображения, `v2` = дополнение API v2 (без отката к стандартным изображениям). Без него: всё, что позволяет ваш ключ. Не разрешено для вашего ключа → `403`. v1v2 |
