Vehicle Imagery API v1.2.0

हर ब्रांड, मॉडल, साल, वेरिएंट, ट्रिम और व्यू के लिए स्टूडियो-क्वालिटी कार इमेज — साइन किए गए CDN URLs के रूप में डिलीवरी की जाती है, जिसमें ऑन-द-फ्लाई फॉर्मेट, साइज, एस्पेक्ट-रेशियो, पेंट कलर, शैडो, ट्रांसपेरेंसी, ग्राउंडिंग और फ्लोर-मिररिंग।

बेस URL

सभी एंडपॉइंट्स https://api.vehicleimagery.com के नीचे लाइव हैं।

प्रमाणीकरण

हर रिक्वेस्ट को x-api-key हेडर में आपका API की चाहिए।

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

आपका की क्या कर सकता है (फॉर्मेट्स, रेशियो, फीचर्स, ब्रांड्स) /api/me द्वारा वापस किया जाता है। दस्तावेज़ एंडपॉइंट्स (/api/openapi.json, /api/docs) पब्लिक हैं और किसी की की आवश्यकता नहीं है।

दो तरीके इनपुट

कार को जानते हैं? कैटलॉग में नेविगेट करें: brand → model → year → variant → trim → view. एक वास्तविक वाहन है? लुकअप एड-ऑन्स का उपयोग करें — GET /vin/{vin} या GET /plate/{plate} एक VIN या रजिस्ट्रेशन नंबर को सीधे वाहन डेटा में बदलता है, साथ ही उस कार के स्टूडियो इमेज भी, जहाँ उपलब्ध हो, उसके वास्तविक पेंट कलर लागू किया जाता है। एड-ऑन्स को प्रति की के आधार पर सक्षम किया जाता है; /api/me दिखाता है कि आपका क्या कर सकता है।

यह कैसे काम करता है

1. कैटलॉग में नेविगेट करें एक कार तक: brand → model → year → variant → trim → view, उदाहरण के लिए GET /api/Abarth/124_Spider_Abarth/2016/Basis/base.
2. एक इमेज को रिज़ॉल्व करें व्यू + ऑप्शन्स को जोड़कर: GET /api/Abarth/124_Spider_Abarth/2016/Basis/base/front_left?format=webp&width=1200 → मेटाडेटा और एक साइन किया हुआ image_url वापस करता है।
3. Embed image_url सीधे अपने <img> में। यह साइन किया गया और ट्रांसफॉर्म-लॉक किया गया है; बाइट्स पहले अनुरोध पर उत्पन्न होते हैं और CDN पर आपके प्लान के TTL के लिए कैश किए जाते हैं (डिफ़ॉल्ट 7 दिन)।

चित्र विकल्प

किसी भी इमेज रिक्वेस्ट में जोड़ें: format, resolution, ratio, width, height, quality, color, shadow, transparency, ground, mirroring. सभी विकल्प स्वतंत्र रूप से मिलते हैं (जैसे ?color=wine_red&shadow=true&format=webp&width=1200). पूर्ण प्लान-फिल्टरेड सेट /api/options में है।

पेंट कलर्स

कार्स की मांग पर रंग बदला जा सकता है - परावर्तन, क्रोम, ग्लास और इंटीरियर अपरिवर्तित रहते हैं; केवल पेंट बदलता है, अपनी फिनिश के अनुसार (सॉलिड या मेटालिक)। /api/colors पूरे कैटलॉग को { color_name, color_make } जोड़ों के रूप में सूचीबद्ध करता है: हाउस कलर्स (black, white, blue, orange, wine_red — color_make: "Vehicleimagery") हर कार पर उपलब्ध हैं; ब्रांड कलर्स (जैसे Kia *Racing Red*) उस ब्रांड के कार्स के लिए हैं। एक कार का अपना /colors एंडपॉइंट दिखाता है कि उसके लिए क्या दिखाया जाता है (हाउस कलर्स + उसके ब्रांड के कलर्स) — कोई भी सक्रिय कैटलॉग कलर किसी भी कार पर ?color= के माध्यम से अनुरोध किया जा सकता है। विवरण: *Paint colors* गाइड /info/guides/colors पर है

शैडोज, ट्रांसपेरेंसी और कम्पोजिटिंग

स्टूडियो ग्राउंड शैडो (shadow=true), ट्रांसपेरेंट कट-आउट्स (transparency=true) और ओपेक व्हाइट डिलीवरी हर एक्स्टीरियर व्यू के लिए डिलीवरी टाइम पर बनाई जाती है। उपलब्धता पूरे कैटलॉग में समान है।

एररनोट्स (गैर-घातक)

जब एक रिक्वेस्ट को ठीक से सर्व नहीं किया जा सकता, तो API फेल नहीं होता — यह सबसे करीबी वैध मान पर फॉलबैक करता है और एक छोटी कोड को errornotes एरे में जोड़ता है (उदाहरण के लिए, Y01 = सबसे करीबी साल का उपयोग किया गया, S05 = छाया उपलब्ध नहीं)। पूर्ण सूची /api/errornotes में है।

चित्र डिलीवरी और कैशिंग

उत्पन्न image_url सीडीएन की ओर इशारा करता है, एक हस्ताक्षर और एक समाप्ति तिथि ले जाता है, और एक सटीक रूपांतरण पर लॉक किया जाता है। ग्राहक इसे बदल नहीं सकते। पहला अनुरोध बाइट्स को रेंडर और कैश करता है, हर बाद का अनुरोध सीधे कैश से सर्व किया जाता है। बस URL को <img src> में डालें।

स्टेटस कोड्स

• 200 — सफलता। हमेशा errornotes को चेक करें ताकि चुपचाप फॉलबैक हो सकें।
• 401 — x-api-key गायब या गलत है।
• 403 — आपका प्लान मांगी गई सुविधा, फॉर्मेट या ब्रांड की अनुमति नहीं देता।
• 404 — उस पथ के लिए कोई डेटा नहीं। संदेश बताता है कि क्या चेक करना है।

परंपराएँ

• ब्रांड / मॉडल / वेरिएंट / ट्रिम नाम केस-इन्सेंसिटिव हैं और आम एलियास स्वीकार करते हैं।
• वर्ष निकटतम उपलब्ध जनरेशन पर स्नैप होते हैं
• कैटलॉग एंडपॉइंट्स JSON रिटर्न करते हैं; इमेज बाइट्स केवल साइन किए गए image_url से आते हैं।