Изображение
Разрешите подписанный URL изображения
GET/api/{brand}/{model}/{year}/{variant}/{trim}/{view}
Основной конечный пункт. Возвращает метаданные плюс подписанный image_url, который вы встраиваете непосредственно в <img>.
Добавьте любой параметр как параметр запроса. Все, что недоступно для автомобиля или не разрешается вашим планом, отображается как ближайшее допустимое значение и отображается в errornotes (а не вызывает сбой).
Примеры
?format=webp&width=1200— WebP, ширина 1200 пикселей.?ratio=16:9&format=jpeg— подогнан под 16:9.?mirroring=true— автомобиль на отражающем полу шоурума.?transparency=true&format=png— вырезанный на прозрачном фоне.?color=wine_red— перекрашен в цвет wine_red.?color=Racing%20Red&shadow=true— краска из каталога Kia плюс студийная тень.
Дополнение к API v2: для автомобилей с дополнительными изображениями применяются дополнительные опции ниже (lights, background, цвет в формате color, windows, plate, fit, size, hotspots), например, ?color=c8102e&windows=dark&size=1080p. С дополнением {view} может также быть группой студии (hero, steered, extra, drone): это перечисляет изображения группы — см. *Дополнение к API v2*.
Параметры пути
| Название | Тип | Описание |
|---|---|---|
brand обязательно | строка | Название бренда или его синоним (независимо от регистра). |
model обязательно | строка | Название модели. |
year обязательно | целое число | Год модели (4 цифры). Если точный год отсутствует, используется ближайшая доступная генерация (ошибка `Y01`). |
variant обязательно | строка | Вариант кузова. |
trim обязательно | строка | Уровень обрезки. |
view обязательно | строка | Название вида — см. /api/views (например, front, front_left, rear). |
Параметры запроса
| Название | Тип | Описание |
|---|---|---|
format | строка | Формат поставки. `auto` выбирает WebP. Оригинал — PNG. pngwebpjpegavifauto |
resolution | строка | Предварительный размер/качество (переопределяется явной шириной/качеством). defaultthumbsmallmediumlargefull |
ratio | строка | Добавить заполнение для соотношения сторон. `default` = нативное. 1:14:33:216:916:102:121:95:43:44:52:39:16 |
width | целое число | Явная ширина в пикселях (привязана к лестнице ширины). |
height | целое число | Явная высота в пикселях. |
quality | целое число | Качество кодировщика (40–100). |
color | строка | Цвет краски по имени (регистр не имеет значения; пробелы кодируются в URL, например, `Racing%20Red`). Автомобиль перекрашивается по запросу — сохраняется оригинальная краска, отражения и отделка. Цвета автомобиля в `/colors` показывают его набор (базовые цвета + цвета бренда); любой активный цвет из `/api/colors` можно запросить. Неизвестный цвет → стандартная краска + ошибка `F04`. Сочетается с любым другим параметром. **Дополнение API v2:** цвета каталога идут с их реальным покрытием (металлик, перламутр, мат, сатин, хром, алюминий, углерод). Также любой 6-значный цвет в формате HEX, например, `c8102e` (глянец), или цвет с покрытием: `<finish>_<hex>`, например, `metallic_315fbf`, `matte_283b56`, `carbon_545454`, `chrome_eac972`; металлик, перламутр и сатин могут иметь дополнительный цвет для эффекта, например, `metallic_315fbf_5693f9`. Покрытия: `solid`, `metallic`, `pearl`, `satin`, `matte` (также `matt`), `chrome`, `aluminium`, `carbon`. |
shadow | строка | Тень от машины на студийном фоне — создаётся при получении, доступна для любого внешнего вида. С `mirroring=true` управляет тенью от днища. truefalse |
transparency | строка | Прозрачный фон с вырезом — доступен для каждого внешнего вида (используйте с PNG/WebP). truefalse |
ground | строка | Разместите автомобиль на земле (требуется прозрачная версия). true |
mirroring | строка | Отражающий пол. `true` = с тенью под днищем, `clean` = только отражение. Требуется прозрачная версия. trueclean |
lights | строка | **Дополнение API v2:** фары включены или выключены. **По умолчанию `включены`:** без параметра изображение приходит с включенными фарами, где бы они ни были; отправьте `lights=off`, чтобы получить изображение без фар. Изображение без варианта с фарами просто приходит без них; с `lights=on` оно также несет ошибку `L26`. onoff |
background | строка | **Дополнение к API v2:** `white` (по умолчанию), `transparent`, или шестизначный шестнадцатеричный цвет, например, `f4f4f4`. Только студийные изображения (образ жизни → ошибка `B32`). |
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`. |
fit | строка | **Дополнение к API v2:** как автомобиль заполняет рамку `ratio` / `size` — `contain` добавляет отступы (по умолчанию), `cover` обрезает. Изображения в стиле жизни всегда обрезаются. containcover |
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 |
