API v2 Add-on

360°-Drehung: alle Frames eines Rings

Holen/api/{brand}/{model}/{year}/{variant}/{trim}/360/{ring}

API v2 Add-on — Schlüssel mit v2-Zugang. Jeder Frame eines Rings in der richtigen Reihenfolge, jeder mit seiner eigenen signierten image_url und seinem Winkel — ein Spin-Viewer benötigt alle diese. Die Bildoptionen (Format, Breite, Farbe, Hintergrund …) gelten für jeden Frame, sodass ein Spin immer konsistent ist.

Pfadparameter

Name	Typ	Beschreibung
`brand` erforderlich	Zeichenkette	Brand name (aktualisierte Katalogbezeichnung für Add-on-Fahrzeuge).
`model` erforderlich	Zeichenkette	Modellname.
`year` erforderlich	Ganzzahl	Modelljahr (4-stellig). Wenn das genaue Jahr fehlt, wird die nächste verfügbare Generation verwendet (Fehlermeldung `Y01`).
`variant` erforderlich	Zeichenkette	Karosserie-Variante.
`trim` erforderlich	Zeichenkette	Ausstattungsvarianten.
`ring` erforderlich	Zeichenkette	Ring: eye_level, niedrig oder hoch (siehe 360°-Drehung: Ringe).

Abfrageparameter.

Name	Typ	Beschreibung
`format`	Zeichenkette	Auslieferungsformat. `pngwebpjpegavifauto`
`width`	Ganzzahl	Breite in px.
`color`	Zeichenkette	Lack: Katalogfarbenname, 6-stellige Hex oder `<finish>_<hex>` (z.B. `metallic_315fbf`).
`color_id`	Ganzzahl	Farbcode nach ID aus `/api/colors`. Verwenden, wenn ein Name mehrmals existiert: die ID ist einzigartig und ändert sich nie. Hat Vorrang vor `color`; `0` ist die Originalfarbe. Unbekannte oder inaktive ID → wie ein unbekannter Name (Standardfarbe + Fehlermeldung `F04`).
`lights`	Zeichenkette	API v2 Zusatz: Scheinwerfer ein- oder ausgeschaltet. Standardmäßig `on`: ohne den Parameter kommt das Bild mit eingeschalteten Lichtern, wo immer das Bild sie hat; senden Sie `lights=off` für ein Bild ohne Lichter. Ein Bild ohne Lichtvariante kommt einfach ohne Lichter; mit `lights=on` enthält es auch den Fehlerhinweis `L26`. `onoff`
`background`	Zeichenkette	API v2 add-on: `white` (Standard), `transparent` oder eine 6-stellige Hex-Farbe wie `f4f4f4`. Nur Studiobilder (Lifestyle → Fehlerhinweis `B32`).
`windows`	Zeichenkette	API v2 add-on: `see_through` = Glas wie im Bild (Standard), `dark` = getönte Scheiben, durch die man nicht hindurchsehen kann. Nicht verfügbar → Fehlerhinweis `W28`. `see_throughdark`
`plate`	Zeichenkette	API v2 add-on: Kennzeichen — `none` = wie im Bild (Standard), `blank` = leeres Kennzeichen, `logo` = Ihr Logo auf dem Kennzeichen (in Ihrem Schlüssel eingerichtet; fehlt → leer + Fehlernotiz `N30`), `text` = Ihr eigener Text aus `plate_text` (muss für Ihren Schlüssel aktiviert sein, siehe `addon.plate_text` in `/api/me`; andernfalls Fehlernotiz `O31`). `noneblanklogotext`
`plate_text`	Zeichenkette	API v2 add-on: der Text für `plate=text` — bis zu 10 Zeichen: Buchstaben, Ziffern, Leerzeichen und `-` `.` `&`. Auf dem Kennzeichen wie gesendet geschrieben (Groß- und Kleinschreibung bleibt erhalten), zentriert und so groß wie das Kennzeichen es zulässt. Fehlt, zu lang oder andere Zeichen → `400`.
`fit`	Zeichenkette	API v2 add-on: wie das Auto ein `ratio` / `size` Feld füllt — `contain` füllt auf (Standard), `cover` schneidet ab. Lifestyle-Bilder decken immer ab. `containcover`
`size`	Zeichenkette	API v2 Add-on: längste Seite `2k` 2560 px, `1080p` 1920 px, `720p` 1280 px, `540p` 960 px, `360p` 640 px, `thumb` 320 px. `width` / `height` übersteigen `size`. `2k1080p720p540p360pthumb`
`version`	Zeichenkette	Ergebnisse nur von einer Version: `v1` = Standardbilder, `v2` = API v2 Zusatz (kein Rückfall auf Standardbilder). Ohne diesen Parameter: alles, was Ihr Schlüssel erlaubt. Nicht erlaubt für Ihren Schlüssel → `403`. `v1v2`

Anfragen

curl "https://api.vehicleimagery.com/api/bmw/m4/2024/coupe/base/360/ring?format=png&width=800" \
  -H "x-api-key: YOUR_API_KEY"

200 · Alle Frames des Rings.

[
  {
    "id": 900000003,
    "brand": "Audi",
    "model": "Q9",
    "year": 2026,
    "variant": "SUV",
    "trim": "Default",
    "group": "360",
    "ring": "eye_level",
    "frames": 32,
    "start": "front",
    "direction": "left",
    "resolution": "default",
    "ratio": "default",
    "format": "webp",
    "settings": {
      "color": "default",
      "lights": "off",
      "background": "white",
      "windows": "see_through",
      "plate": "none"
    },
    "images": [
      {
        "frame": 1,
        "angle": 0,
        "view": "360/eye_level/01",
        "image_url": "https://api.vehicleimagery.com/image/3/360-eye-level/01-of-32.webp?…"
      },
      {
        "frame": 2,
        "angle": 11.25,
        "view": "360/eye_level/02",
        "image_url": "https://api.vehicleimagery.com/image/3/360-eye-level/02-of-32.webp?…"
      }
    ]
  }
]

401 · Fehlender oder ungültiger `x-api-key`.

{
  "error": "Invalid API key"
}

403 · Planbeschränkung (Funktion, Format oder Marke nicht erlaubt) oder blockierter Anfrage.

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

404 · Keine Daten für den angeforderten Pfad. Bei einem Auto-Pfad gibt `not_found` die Ebene an, die nicht existiert, und `alternatives` listet auf, was stattdessen existiert.

{
  "error": "Model '9 series' not found for 'BMW' — check /api/BMW for valid models.",
  "code": "model_not_found",
  "not_found": "model",
  "alternatives": {
    "models": [
      "1 series",
      "2 series",
      "3 series",
      "4 series",
      "5 series"
    ]
  }
}