Image

Résolvez une URL d'image signée

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

Le point de terminaison principal. Renvoie les métadonnées plus une image_url signée que vous intégrez directement dans un <img>.

Ajoutez n'importe quelle option en tant que paramètre de requête. Tout ce qui n'est pas disponible pour la voiture ou non autorisé par votre plan revient à la valeur valide la plus proche et est rapporté dans errornotes (plutôt que de ne pas fonctionner).

Exemples

?format=webp&width=1200 — WebP, 1200 px de large.
?ratio=16:9&format=jpeg — rembourré à 16:9.
?mirroring=true — voiture sur un sol de showroom réfléchissant.
?transparency=true&format=png — découpe sur fond transparent.
?color=wine_red — repeint dans la couleur maison wine_red.
?color=Racing%20Red&shadow=true — peinture de catalogue Kia plus ombre studio.

Add-on API v2: pour les voitures avec des images supplémentaires, les options supplémentaires ci-dessous s'appliquent (lights, background, couleur hex color, windows, plate, fit, size, hotspots), par exemple ?color=c8102e&windows=dark&size=1080p. Avec l'add-on, {view} peut également être un groupe de studio (hero, steered, extra, drone): cela liste les images du groupe — voir *Add-on API v2*.

Paramètres de chemin

Nom	Type	Description
`brand` obligatoire	chaîne	Nom de marque ou alias (insensible à la casse).
`model` obligatoire	chaîne	Nom du modèle.
`year` obligatoire	entier	Année du modèle (4 chiffres). Si l'année exacte est manquante, la génération disponible la plus proche est utilisée (note d'erreur `Y01`).
`variant` obligatoire	chaîne	Variante de carrosserie.
`trim` obligatoire	chaîne	Niveau de finition
`view` obligatoire	chaîne	Nom de la vue - voir /api/views (ex. front, front_left, rear).

Paramètres de requête.

Nom	Type	Description
`format`	chaîne	Format de livraison. `auto` choisit WebP. Original est PNG. `pngwebpjpegavifauto`
`resolution`	chaîne	Préréglage de taille/qualité (remplacé par la largeur/qualité explicite). `defaultthumbsmallmediumlargefull`
`ratio`	chaîne	Remplir pour un rapport d'aspect. `default` = natif. `1:14:33:216:916:102:121:95:43:44:52:39:16`
`width`	entier	Largeur explicite en px (arrondie à l'échelle de largeur).
`height`	entier	Hauteur explicite en px.
`quality`	entier	Qualité de l'encodeur (40–100).
`color`	chaîne	Couleur de peinture par nom (insensible à la casse; encodez les espaces en URL, par exemple `Racing%20Red`). La voiture est repeinte à la demande — finition vraie, reflets et garnitures conservés. Les `/colors` d'une voiture listent son ensemble affiché (couleurs maison + couleurs de sa marque); toute couleur active de `/api/colors` peut être demandée. Couleur inconnue → peinture par défaut + note d'erreur `F04`. Se combine avec toutes les autres options. Add-on API v2: les couleurs du catalogue viennent avec leur finition réelle (métallique, perlé, mat, satiné, chrome, aluminium, carbone). De plus, toute couleur de peinture hexadécimale à 6 chiffres, par exemple `c8102e` (brillant), ou une couleur hexadécimale avec une finition: `<finish>_<hex>`, par exemple `metallic_315fbf`, `matte_283b56`, `carbon_545454`, `chrome_eac972`; métallique, perlé et satiné prennent une deuxième couleur optionnelle pour l'effet, par exemple `metallic_315fbf_5693f9`. Finitions: `solid`, `metallic`, `pearl`, `satin`, `matte` (aussi `matt`), `chrome`, `aluminium`, `carbon`.
`shadow`	chaîne	Ombre au sol du studio — produite au moment de la livraison, disponible pour chaque vue extérieure. Avec `mirroring=true` cela contrôle l'ombre sous le véhicule à la place. `truefalse`
`transparency`	chaîne	Fond transparent découpé — disponible pour chaque vue extérieure (utiliser avec PNG/WebP). `truefalse`
`ground`	chaîne	Placez la voiture au sol (nécessite une variante transparente). `true`
`mirroring`	chaîne	Sol réfléchissant. `true` = avec ombre sous la carrosserie, `clean` = réflexion seulement. Nécessite une variante transparente. `trueclean`
`lights`	chaîne	Add-on de l'API v2 : phares allumés ou éteints. Par défaut `on` : sans le paramètre, l'image arrive avec les phares allumés là où l'image les possède ; envoyez `lights=off` pour une image sans phares. Une image sans variante éclairée arrive simplement sans phares ; avec `lights=on` elle porte également la note d'erreur `L26`. `onoff`
`background`	chaîne	Add-on API v2 : `white` (par défaut), `transparent`, ou une couleur hexadécimale à 6 chiffres comme `f4f4f4`. Images studio uniquement (lifestyle → erreur `B32`).
`windows`	chaîne	Add-on API v2 : `see_through` = vitrage comme dans l'image (par défaut), `dark` = vitrage teinté opaque. Non disponible → erreur `W28`. `see_throughdark`
`plate`	chaîne	Add-on API v2 : plaque d'immatriculation — `none` = comme sur l'image (par défaut), `blank` = plaque vide, `logo` = votre logo sur la plaque (à configurer sur votre clé; manquant → vide + note d'erreur `N30`), `text` = votre propre texte à partir de `plate_text` (doit être activé pour votre clé, voir `addon.plate_text` dans `/api/me`; sinon note d'erreur `O31`). `noneblanklogotext`
`plate_text`	chaîne	Add-on API v2 : le texte pour `plate=text` — jusqu'à 10 caractères: lettres, chiffres, espaces et `-` `.` `&`. Écrit sur la plaque comme envoyé (majuscules et minuscules conservées), centré et aussi grand que la plaque le permet. Manquant, trop long ou autres caractères → `400`.
`fit`	chaîne	Add-on API v2 : comment la voiture remplit une boîte `ratio` / `size` — `contain` rembourre (par défaut), `cover` recadre. Les images lifestyle couvrent toujours. `containcover`
`size`	chaîne	Add-on API v2 : côté le plus long — `2k` 2560 px, `1080p` 1920 px, `720p` 1280 px, `540p` 960 px, `360p` 640 px, `thumb` 320 px. `width` / `height` prennent le pas sur `size`. `2k1080p720p540p360pthumb`
`hotspots`	chaîne	Add-on API v2 : ajouter `hotspots` à la réponse — points d'intérêt (jantes, phares, etc.) en fractions 0–1 de l'image, par exemple pour les visionneuses interactives. `true`
`version`	chaîne	Résultats d'une seule version: `v1` = images standard, `v2` = add-on API v2 (pas de retour aux images standard). Sans cela: tout ce que votre clé permet. Non autorisé pour votre clé → `403`. `v1v2`

Demande

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

200 · Métadonnées d'image incluant l'`image_url` signée.

[
  {
    "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 · Clé `x-api-key` manquante ou invalide.

{
  "error": "Invalid API key"
}

403 · Restriction de plan (fonctionnalité, format ou marque non autorisés) ou demande bloquée.

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

404 · Aucune donnée pour le chemin demandé.

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