ابدأ

التحقق من الهوية

كل طلب يتم تصديقه باستخدام مفتاح API، يرسل كعنوان x-api-key

مفتاح API الخاص بك. يتم إرساله مع كل طلب باستثناء نقاط نهاية وثائق عامة.

المفتاحين والخطط

كل مفتاح مرتبط بخطة تحدد ما يمكن الوصول إليه، أي مشاهد، ألوان، تنسيقات، أحجام، وميزات متاحة، وكيفية عمل الحلول البديلة. طلب بدون مفتاح يعيد 401؛ طلب خارج الخطة يعيد 403.

أفضل الممارسات

احتفظ بالمفتاح خارج الكود العمومي على الجانب العميل كلما أمكن، واستخدم مفتاحًا منفصلًا لكل بيئة، وقم بتدويرهم بانتظام. إذا تم كشف المفتاح، فإلغِه وخلق مفتاحًا جديدًا.

طلب مصادق عليه

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

401 · مفتاح مفقود أو غير صالح.

{ "error": "Invalid API key" }

403 · قيود الخطة

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