ابدأ

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

كل طلب يتم تصديق عليه باستخدام مفتاح واجهة برمجة التطبيقات، المرسل كعنوان 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." }