إضافة API v2

حلل صورة مجموعة الاستوديو

GET/api/{brand}/{model}/{year}/{variant}/{trim}/{group}/{image}

إضافة API v2 — مفاتيح بوصول v2. صورة واحدة لمجموعة استوديو: hero (صور رئيسية، بعضها من مستوى الأرض)، steered (عجلات الأمامية موجهة)، extra (زوايا إضافية من ثلاثة ارتفاعات للكاميرا، زوايا إضافية عند 30° و45°)، drone (من الأعلى). يتم شرح المجموعات وأسماء الصور على *مجموعة الاستوديو: قائمة صورها*.

GET …/{trim} يسرد المجموعات التي يحتوي عليها سيارة (groups)، GET …/{trim}/{group} يسرد صور مجموعة واحدة (views). ثم قم بحل واحدة هنا. يأخذ كل خيارات الصورة، بما في ذلك خيارات الإضافة (lights, background, اللون السداسي color, windows, plate, fit, size, hotspots).

مثال: GET /api/Audi/Q9/2026/SUV/Default/hero → { group: "hero", views: { front_left: true, front_left_ground: true, … } }, ثم GET /api/Audi/Q9/2026/SUV/Default/hero/front_left?color=c8102e&size=1080p&format=webp.

معاملات المسار

اسم	نوع	وصف
`brand` مطلوب	string	اسم العلامة التجارية (تحديث تسمية فهرس الإضافات)
`model` مطلوب	string	اسم النموذج.
`year` مطلوب	عدد صحيح	عام النموذج (4 أرقام). إذا كان العام الدقيق مفقودًا، يتم استخدام الجيل الأقرب المتاح (ملاحظة الخطأ `Y01`).
`variant` مطلوب	string	نوع الجسم.
`trim` مطلوب	string	مستوى القطع.
`group` مطلوب	string	مجموعات الاستوديو: بطل، مدفوع، إضافي، طائرة بدون طيار (انظر `groups` في نهاية القطع).
`image` مطلوب	string	صورة المجموعة (انظر `views` للمجموعة).

معاملات الاستعلام

اسم	نوع	وصف
`format`	string	تنسيق التوصيل. `pngwebpjpegavifauto`
`ratio`	string	نسبة العرض إلى الارتفاع. `1:14:33:216:916:102:121:95:43:44:52:39:16`
`width`	عدد صحيح	العرض بالبكسل.
`color`	string	الطلاء: اسم اللون من الكتالوج، أو سداسي الأرقام، أو `<finish>_<hex>` (على سبيل المثال `metallic_315fbf`).
`color_id`	عدد صحيح	طلاء اللون حسب معرفه من `/api/colors`. استخدمه عندما يوجد اسم أكثر من مرة: المعرف فريد ولا يتغير أبدًا. يتفوق على `color`؛ `0` هو الطلاء الأصلي. معرف غير معروف أو غير نشط → نفس الاسم غير المعروف (الطلاء الافتراضي + ملاحظة الخطأ `F04`).
`shadow`	string	ظل الأرض في الاستوديو. `truefalse`
`lights`	string	إضافة v2 لـ Vehicle Imagery: إضاءة الأمامية مشتعلة أو مطفأة. افتراضيًا مشتعلة: بدون المعلمة تأتي الصورة مع الأضواء مشتعلة حيثما تكون الأضواء موجودة؛ أرسل `lights=off` للحصول على صورة بدون أضواء. صورة لا تحتوي على نسخة مضاءة تأتي بدون أضواء؛ مع `lights=on` تحمل أيضًا ملاحظة الخطأ `L26`. `onoff`
`background`	string	ميزة إضافية لـ API v2: `white` (الافتراضي)، `transparent`، أو لون سداسي الأرقام مثل `f4f4f4`. صور الاستوديو فقط (صور نمط الحياة → خطأ `B32`).
`windows`	string	ميزة إضافية لـ API v2: `see_through` = الزجاج كما في الصورة (الافتراضي)، `dark` = الزجاج الخاص الذي لا يمكن رؤية من خلاله. غير متوفر → خطأ `W28`. `see_throughdark`
`plate`	string	إضافة API v2: لوحة الترخيص — `none` = كما في الصورة (الافتراضي)، `blank` = لوحة فارغة، `logo` = شعارك على اللوحة (إعداد على مفتاحك؛ إذا كان مفقودًا → فارغ + ملاحظة خطأ `N30`)، `text` = نصك الخاص من `plate_text` (يجب تفعيله لمفتاحك، انظر `addon.plate_text` في `/api/me`؛ وإلا ملاحظة خطأ `O31`). `noneblanklogotext`
`plate_text`	string	إضافة API v2: النص لـ `plate=text` — حتى 10 أحرف: حروف، أرقام، مسافات و `-` `.` `&`. يكتب على اللوحة كما أرسل، يحافظ على الحروف الكبيرة والصغيرة، مركز ومكبر بقدر ما تسمح اللوحة. إذا كان مفقودًا، طويلًا جدًا أو يحتوي على أحرف أخرى → `400`.
`fit`	string	ميزة إضافية لـ API v2: كيفية ملء السيارة لمربع `ratio` / `size` — `contain` يضيف (الافتراضي)، `cover` يقطع. صور نمط الحياة تغطي دائمًا. `containcover`
`size`	string	إضافة v2 لـ Vehicle Imagery: الجانب الأطول — `2k` 2560 بكسل، `1080p` 1920 بكسل، `720p` 1280 بكسل، `540p` 960 بكسل، `360p` 640 بكسل، `thumb` 320 بكسل. `width` / `height` يتغلب على `size`. `2k1080p720p540p360pthumb`
`hotspots`	string	ميزة إضافية لـ API v2: أضف `hotspots` إلى الاستجابة — نقاط الاهتمام (الأشعة، الأضواء الأمامية ...) ككسور 0–1 من الصورة، على سبيل المثال لمشاهدات تفاعلية. `true`
`version`	string	نتائج من نسخة واحدة فقط: `v1` = صور قياسية، `v2` = إضافة API v2 (بدون العودة إلى الصور القياسية). بدونها: كل ما يسمح به مفتاحك. غير مسموح به لمفتاحك → `403`. `v1v2`

طلب

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

200 · بيانات الصورة الوصفية بما في ذلك عنوان الصورة الموقعة `image_url`.

[
  {
    "id": 900000003,
    "brand": "Audi",
    "model": "Q9",
    "year": 2026,
    "variant": "SUV",
    "trim": "Default",
    "version": "v2",
    "view": "hero/front_left",
    "resolution": "default",
    "ratio": "default",
    "format": "webp",
    "settings": {
      "color": "c8102e",
      "color_id": null,
      "color_manufacture": null,
      "shadow": false,
      "transparency": false,
      "watermark": false,
      "ground": false,
      "mirroring": false,
      "lights": "on",
      "background": "white",
      "windows": "see_through",
      "plate": "none",
      "size": "1080p"
    },
    "image_url": "https://api.vehicleimagery.com/image/3/hero/front-left.webp?color=c8102e&lights=on&h=1920&kid=…&v=…&exp=…&sig=…"
  }
]

401 · مفتاح `x-api-key` مفقود أو غير صالح.

{
  "error": "Invalid API key"
}

403 · قيود الخطة (الميزة أو التنسيق أو العلامة التجارية غير مسموح بها) أو طلب محظور.

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

404 · لا توجد بيانات للمسار المطلوب. للمسار الخاص بالسيارة، `not_found` يسمي المستوى الذي لا يوجد، و`alternatives` يسرد ما يوجد هناك بدلاً منه.

{
  "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"
    ]
  }
}