الحساب

ما يمكن لهذا المفتاح فعله

GET/api/me

قدرات مفتاحك في مكالمة واحدة: الميزات المسموح بها، التنسيقات/الدقة/النسبة/المناظر/الألوان/العلامات التجارية المسموح بها، القيود، ومعلومات التوصيل (مضيف CDN + مدة صلاحية الرابط الموقعة).

Add-ons تظهر تحت features: vin و plate تشير إلى ما إذا كانت نقاط النهاية للبحث ممكّنة لك. search_allowed تصف كيفية حساب الوصول إلى الكتالوج والصور — for free (مضمنة)، extra cost (مفروضة لكل طلب)، prepaid، أو disabled.

طلب

curl "https://api.vehicleimagery.com/api/me" \
  -H "x-api-key: YOUR_API_KEY"

200 · القدرات الرئيسية.

{
  "features": {
    "shadow": true,
    "transparency": true,
    "mirroring": true,
    "grounding": true,
    "getall": true,
    "debug": false,
    "fallbacks": true,
    "watermark_forced": false,
    "beta_colors": false,
    "vin": true,
    "plate": true,
    "search_allowed": "for free"
  },
  "allowed": {
    "formats": [
      "*"
    ],
    "resolutions": [
      "*"
    ],
    "ratios": [
      "*"
    ],
    "views": [
      "*"
    ],
    "colors": [
      "*"
    ],
    "brands": [
      "*"
    ]
  },
  "restrictions": {
    "blocked_brands": [],
    "year_range": null,
    "test_mode": false
  },
  "delivery": {
    "cdn": "cdn.vehicleimagery.com",
    "signed_url_ttl_seconds": 604800
  }
}

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

{
  "error": "Invalid API key"
}

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

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

404 · لا توجد بيانات للمسار المطلوب.

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