نظرة عامة على REST API

نظرة عامة على REST API

تقدم المنصة واجهة برمجة تطبيقات REST شاملة تحت /api/، مما يتيح لك بناء واجهات متاجر مخصصة، تطبيقات موبايل، تكاملات مع أطراف ثالثة، ونصوص أتمتة.

المصادقة

تستخدم واجهة برمجة التطبيقات Laravel Sanctum للمصادقة المعتمدة على الرموز.

الحصول على رمز

POST /api/auth/login
Content-Type: application/json

{
  "email": "[email protected]",
  "password": "your-password"
}

تتضمن الاستجابة حقل token. مرره كرمز Bearer في الطلبات التالية:

Authorization: Bearer {your-token}

تنسيق الاستجابة

تستخدم جميع الاستجابات غلافًا متسقًا:

{
  "status": true,
  "message": "تم استرجاع المنتجات بنجاح",
  "data": { ... }
}

تعود أخطاء التحقق مع HTTP 422 مع كائن errors.

إصدار

تكون واجهة برمجة التطبيقات مُصدرة عبر بادئة URL. الإصدار الثابت الحالي هو /api/v1/. يتم إدخال التغييرات الكبيرة فقط في إصدار جديد.

تحديد المعدل

تكون طلبات واجهة برمجة التطبيقات محدودة بمعدل 60 طلبًا في الدقيقة لكل مستخدم مصدق. تجاوز هذا يعيد HTTP 429 مع رأس Retry-After.