مِرفادMIRFAD
للمطورين

واجهات مِرفاد البرمجية

REST API بصيغة JSON لربط متجرك بأي نظام: ERP، محاسبة، تطبيقات جوال، أو أتمتة. متاحة في الباقة الاحترافية وما فوق.

المصادقة

احصل على مفتاح API من لوحة التحكم ← التطبيقات ← واجهات المطورين، وأرسله في كل طلب:

curl https://mirfad.azzam.cc/api/v1/products \
  -H "Authorization: Bearer mf_xxxxxxxxxxxxxxxx"

الحد الأقصى 600 طلب في الدقيقة. جميع المبالغ بالريال (أرقام عشرية). الاستجابات بصيغة { data, meta } والأخطاء { error: { code, message } }.

نقاط الوصول

  • GET/api/v1/productsقائمة المنتجات (page, limit, q, status)
  • POST/api/v1/productsإنشاء منتج
    { "name": "تيشيرت", "price": 79, "sku": "TS-1", "quantity": 20 }
  • GET/api/v1/products/{id}تفاصيل منتج مع المتغيرات والمخزون
  • PATCH/api/v1/products/{id}تعديل منتج
    { "price": 69, "status": "ACTIVE" }
  • DELETE/api/v1/products/{id}حذف منتج
  • GET/api/v1/ordersقائمة الطلبات (status, payment_status)
  • POST/api/v1/ordersإنشاء طلب
    { "items": [{ "variant_id": "...", "quantity": 2 }], "customer": { "name": "سارة", "phone": "0550000000" }, "payment_method": "cod" }
  • GET/api/v1/orders/{id|number}تفاصيل الطلب والسجل الزمني والشحنات
  • PATCH/api/v1/orders/{id}تحديث الحالة أو تأكيد الدفع
    { "status": "SHIPPED", "notify_customer": true }
  • GET/api/v1/customersقائمة العملاء (q)
  • POST/api/v1/customersإضافة عميل
    { "name": "خالد", "email": "k@example.com" }
  • GET/api/v1/inventoryالمخزون لكل متغير وفرع
  • PUT/api/v1/inventoryتحديث المخزون دفعة واحدة (حتى 500)
    { "updates": [{ "sku": "TS-1", "quantity": 15, "mode": "set" }] }

Webhooks

أضف رابطًا من لوحة التحكم وستصلك طلبات POST عند وقوع الأحداث. تحقق من التوقيع بحساب HMAC-SHA256 لجسم الطلب بالسر الخاص بالـ Webhook ومقارنته بالترويسة X-Mirfad-Signature.

order.createdorder.updatedorder.paidorder.canceledproduct.createdproduct.updatedcustomer.createdinventory.lowshipment.updatedreturn.created
// Node.js
const sig = crypto.createHmac("sha256", SECRET).update(rawBody).digest("hex");
if (sig !== req.headers["x-mirfad-signature"]) return res.status(401).end();

موجز المنتجات

رابط XML عام لكتالوجات Google وMeta وTikTok:

https://mirfad.azzam.cc/api/feed/{store-slug}