Complemento de API v2

Estilo de vida: resolver una imagen

OBTENER/api/{brand}/{model}/{year}/{variant}/{trim}/lifestyle/{scene}/{image}

API v2 add-on — claves con acceso a v2. Una imagen de estilo de vida con un image_url firmado. Las imágenes de estilo de vida son escenas completas: siempre llenan el marco (fit=cover), un background no se aplica (errornote B32). Pintura (color), lights, size, ratio y format funcionan como en todas partes.

Parámetros de ruta

Nombre	Tipo	Descripción
`brand` requerido	cadena	Nombre de la marca (nombres de catálogo actualizados para los coches adicionales).
`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.
`scene` requerido	cadena	Escena.
`image` requerido	cadena	Imagen de la escena (ver Lifestyle: imágenes de una escena).

Parámetros de consulta

Nombre	Tipo	Descripción
`format`	cadena	Formato de entrega. `pngwebpjpegavifauto`
`ratio`	cadena	Relación de aspecto (recortado para llenar). `1:14:33:216:916:102:121:95:43:44:52:39:16`
`color`	cadena	Pintura: nombre del color del catálogo o hexadecimal de 6 dígitos.
`lights`	cadena	API v2 complemento: faros encendidos o apagados (predeterminado `off`). No disponible para una imagen → `off` + errornote `L26`. `onoff`
`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 matrícula — `none` = como en la imagen (predeterminado), `blank` = placa vacía, `logo` = su logo en la placa (configurado en su clave; faltante → en blanco + errornote `N30`). `noneblanklogo`
`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`

Solicitud

curl "https://api.vehicleimagery.com/api/bmw/m4/2024/coupe/base/lifestyle/scene/image?format=png&ratio=1:1" \
  -H "x-api-key: YOUR_API_KEY"

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

[
  {
    "id": 900000003,
    "brand": "Audi",
    "model": "Q9",
    "year": 2026,
    "variant": "SUV",
    "trim": "Default",
    "view": "lifestyle/garden_pavilion/front_left_glass_wall",
    "resolution": "default",
    "ratio": "default",
    "format": "jpeg",
    "settings": {
      "color": "default",
      "shadow": false,
      "transparency": false,
      "watermark": false,
      "ground": false,
      "mirroring": false,
      "lights": "off",
      "background": null,
      "windows": "see_through",
      "plate": "none",
      "fit": "cover"
    },
    "image_url": "https://api.vehicleimagery.com/image/3/lifestyle/garden-pavilion/front-left-glass-wall.jpeg?kid=…&v=…&exp=…&sig=…"
  }
]

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."
}