Imagen

Resuelve una URL de imagen firmada

OBTENER/api/{brand}/{model}/{year}/{variant}/{trim}/{view}

El punto final principal. Devuelve metadatos más una image_url firmada que incrustas directamente en un <img>.

Agregue cualquier opción como parámetro de consulta. Cualquier cosa no disponible para el auto o no permitida por su plan se reemplaza con el valor válido más cercano y se informa en errornotes (en lugar de fallar).

Ejemplos

?format=webp&width=1200 — WebP, 1200 px de ancho.
?ratio=16:9&format=jpeg — rellenado a 16:9.
?mirroring=true — coche en un suelo de showroom reflectante.
?transparency=true&format=png — recortado sobre fondo transparente.
?color=wine_red — Repintado en el color de casa wine_red.
?color=Racing%20Red&shadow=true — Pintura de catálogo Kia Racing Red más sombra de estudio.

API v2 add-on: for cars with add-on images the extra options below apply (lights, background, hex color, windows, plate, fit, size, hotspots), e.g. ?color=c8102e&windows=dark&size=1080p. With the add-on {view} can also be a studio group (hero, steered, extra, drone): that lists the group's images — see *API v2 Add-on*.

Parámetros de ruta

Nombre	Tipo	Descripción
`brand` requerido	cadena	Nombre de marca o alias (no distingue entre mayúsculas y minúsculas).
`model` requerido	cadena	Nombre del modelo.
`year` requerido	integer	Año del modelo (4 dígitos). Si falta el año exacto, se usa la generación más cercana disponible (nota de error `Y01`).
`variant` requerido	cadena	Variante de carrocería.
`trim` requerido	cadena	Nivel de acabado.
`view` requerido	cadena	Nombre de la vista, ver /api/views (por ejemplo, frontal, frontal_izquierdo, trasero).

Parámetros de consulta

Nombre	Tipo	Descripción
`format`	cadena	Formato de entrega. `auto` elige WebP. El original es PNG. `pngwebpjpegavifauto`
`resolution`	cadena	Preajuste de tamaño/calidad (anulado por ancho/calidad explícito). `defaultthumbsmallmediumlargefull`
`ratio`	cadena	Rellenar hasta una relación de aspecto. `default` = nativa. `1:14:33:216:916:102:121:95:43:44:52:39:16`
`width`	integer	Ancho explícito en px (ajustado a la escalera de ancho).
`height`	integer	Altura explícita en px.
`quality`	integer	Calidad del codificador (40:100).
`color`	cadena	Color de pintura por nombre (sin distinguir mayúsculas y minúsculas; codificar espacios en URL, por ejemplo, `Racing%20Red`). El coche se repinta bajo demanda - acabado real, reflejos y acabados preservados. El `/colors` de un coche lista su conjunto mostrado (colores de la casa + los colores de su marca); cualquier color activo de `/api/colors` puede ser solicitado. Color desconocido → pintura predeterminada + nota de error `F04`. Se combina con todas las demás opciones. Adición de API v2: los colores del catálogo vienen con su acabado real (metálico, perlado, mate, satinado, cromado, aluminio, carbono). También cualquier color de pintura hexadecimal de 6 dígitos, por ejemplo, `c8102e` (brillante), o un color hexadecimal con un acabado: `<finish>_<hex>`, por ejemplo, `metallic_315fbf`, `matte_283b56`, `carbon_545454`, `chrome_eac972`; metálico, perlado y satinado admiten un segundo color opcional para el efecto, por ejemplo, `metallic_315fbf_5693f9`. Acabados: `solid`, `metallic`, `pearl`, `satin`, `matte` (también `matt`), `chrome`, `aluminium`, `carbon`.
`shadow`	cadena	Sombra del suelo del estudio, producida en el momento de la entrega, disponible para cualquier vista exterior. Con `mirroring=true` esto controla la sombra del chasis en su lugar. `truefalse`
`transparency`	cadena	Fondo transparente recortado — disponible para cada vista exterior (usar con PNG/WebP). `truefalse`
`ground`	cadena	Coloca el coche en el suelo (necesita una variante transparente). `true`
`mirroring`	cadena	Suelo reflectante. `true` = con sombra del chasis, `clean` = solo reflejo. Necesita una variante transparente. `trueclean`
`lights`	cadena	API v2 complemento: faros encendidos o apagados. Predeterminado `on`: sin el parámetro la imagen viene con las luces encendidas dondequiera que la imagen las tenga; envíe `lights=off` para una imagen sin luces. Una imagen sin variante de luz simplemente viene sin luces; con `lights=on` también lleva la notificación de error `L26`. `onoff`
`background`	cadena	API v2 complemento: `white` (predeterminado), `transparent`, o un color hexadecimal de 6 dígitos como `f4f4f4`. Solo imágenes de estudio (lifestyle → errornote `B32`).
`windows`	cadena	API v2 complemento: `see_through` = vidrio como en la imagen (predeterminado), `dark` = vidrio de privacidad que no se puede ver a través. No disponible → errornote `W28`. `see_throughdark`
`plate`	cadena	API v2 complemento: placa de licencia — `none` = como en la imagen (predeterminado), `blank` = placa vacía, `logo` = su logo en la placa (configurado en su clave; si falta → vacía + notadeerror `N30`), `text` = su propio texto de `plate_text` (debe estar habilitado para su clave, consulte `addon.plate_text` en `/api/me`; de lo contrario, notadeerror `O31`). `noneblanklogotext`
`plate_text`	cadena	API v2 complemento: el texto para `plate=text` — hasta 10 caracteres: letras, dígitos, espacios y `-` `.` `&`. Se escribe en la placa como se envía (se mantienen las mayúsculas y minúsculas), centrado y tan grande como lo permita la placa. Falta, demasiado largo o caracteres distintos → `400`.
`fit`	cadena	API v2 complemento: cómo el coche llena una caja `ratio` / `size` — `contain` rellena (predeterminado), `cover` recorta. Las imágenes lifestyle siempre cubren. `containcover`
`size`	cadena	API v2 complemento: lado más largo — `2k` 2560 px, `1080p` 1920 px, `720p` 1280 px, `540p` 960 px, `360p` 640 px, `thumb` 320 px. `width` / `height` prevalecen sobre `size`. `2k1080p720p540p360pthumb`
`hotspots`	cadena	API v2 complemento: añadir `hotspots` a la respuesta — puntos de interés (llantas, faros …) como fracciones 0–1 de la imagen, por ejemplo, para visualizadores interactivos. `true`
`version`	cadena	Resultados de una sola versión: `v1` = imágenes estándar, `v2` = complemento de la API v2 (sin retroceso a las imágenes estándar). Sin él: todo lo que permita tu clave. No permitido para tu clave → `403`. `v1v2`

Solicitud

curl "https://api.vehicleimagery.com/api/bmw/m4/2024/coupe/base/front?format=png&resolution=default" \
  -H "x-api-key: YOUR_API_KEY"

200 · Metadatos de la imagen incluyendo la `image_url` firmada.

[
  {
    "id": 47456,
    "brand": "Abarth",
    "model": "124_Spider_Abarth",
    "year": 2016,
    "variant": "Basis",
    "trim": "base",
    "view": "front_left",
    "resolution": "default",
    "ratio": "default",
    "format": "webp",
    "settings": {
      "color": "default",
      "shadow": false,
      "transparency": false,
      "watermark": false,
      "ground": false,
      "mirroring": false,
      "width": 800
    },
    "image_url": "https://cdn.vehicleimagery.com/source/01KVJC5S0S639G46CASP7EK8HG?f=webp&q=82&w=800&verify=…&expire=…"
  }
]

401 · `x-api-key` faltante o inválida.

{
  "error": "Invalid API key"
}

403 · Restricción del plan (característica, formato o marca no permitidos) o solicitud bloqueada.

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

404 · No hay datos para la ruta solicitada.

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