واجهة المتجر البرمجية

كل ما تحتاجه واجهة متجر مخصصة أو تطبيق جوال، على https://api.matgrk.com/v1.

  • كل طلب — عدا مسارَي الرموز — يحتاج Authorization: Bearer <access token> — راجع المصادقة.
  • الرمز صالح في متجر واحد بالضبط، وكل مسار يتطلب أحد نطاقات الرمز.
  • الأسعار يحسبها matgrk دائمًا — العميل لا يرسل سعرًا أبدًا.

الرموز

  • POST/v1/auth/anonymousاستبدال مفتاح API برمزَي وصول وتحديث
  • POST/v1/auth/refreshتدوير الرمزين باستخدام رمز التحديث

الكتالوج

النطاق المطلوب: catalogue:read

  • GET/v1/catalogue/productsقائمة منتجات المتجر
  • GET/v1/catalogue/product/{slug}منتج واحد عبر مُعرِّفه النصي
  • GET/v1/catalogue/products-by-idsمنتجات لقائمة معرِّفات

البحث والفروع

النطاق المطلوب: search:read

  • GET/v1/search/suggestاقتراحات أثناء كتابة البحث
  • GET/v1/search/contextسياق صفحة نتائج البحث
  • GET/v1/branchesفروع المتجر

السلة

النطاق المطلوب: cart:read, cart:write

  • GET/v1/cartالسلة الحالية
  • POST/v1/cartإنشاء سلة
  • POST/v1/cart/linesإضافة عنصر إلى السلة
  • PATCH/v1/cart/lines/{lineId}تعديل عنصر في السلة
  • DELETE/v1/cart/lines/{lineId}حذف عنصر من السلة
  • POST/v1/cart/couponتطبيق كوبون
  • DELETE/v1/cart/couponإزالة الكوبون

إتمام الطلب

النطاق المطلوب: checkout:write

  • POST/v1/checkout/delivery-optionsخيارات التوصيل للسلة
  • POST/v1/checkout/payment-optionsخيارات الدفع للسلة
  • POST/v1/checkout/quoteتسعيرة كاملة للسلة
  • PATCH/v1/checkout/detailsتحديد بيانات المتسوق والتوصيل
  • PUT/v1/checkout/fulfilmentاختيار طريقة التسليم
  • GET/v1/checkout/collection-branchesالفروع المتاحة للاستلام
  • POST/v1/checkout/placeإتمام الطلب
  • GET/v1/checkout/confirmationتأكيد الطلب بعد إتمامه
  • POST/v1/checkout/returnedالعودة من صفحة بوابة الدفع

حسابات المتسوقين

النطاق المطلوب: account:read, account:write

  • POST/v1/account/registerتسجيل حساب متسوق
  • POST/v1/account/sign-inتسجيل دخول المتسوق
  • POST/v1/account/sign-outتسجيل خروج المتسوق
  • POST/v1/account/otp/requestطلب رمز تحقق لمرة واحدة
  • POST/v1/account/otp/verifyالتحقق من الرمز
  • POST/v1/account/passwordتغيير كلمة المرور
  • POST/v1/account/password-resetبدء استعادة كلمة المرور
  • POST/v1/account/verify-emailتأكيد البريد الإلكتروني
  • GET/v1/accountملف المتسوق
  • GET/v1/account/addressesعناوين المتسوق
  • POST/v1/account/addressesإضافة عنوان
  • PATCH/v1/account/addresses/{addressId}تعديل عنوان
  • DELETE/v1/account/addresses/{addressId}حذف عنوان

الطلبات

النطاق المطلوب: orders:read

  • GET/v1/ordersطلبات المتسوق المسجَّل

للتسعير وإتمام الطلب حدودهما الخاصة لكل سلة ولكل متسوق فوق حدّ المفتاح — راجع الأعراف.