توثيق API

هذا التوثيق يشرح كيفية استخدام الـ API لنقاط النهاية المخصصة في موقعك.

المصادقة

يجب على جميع الطلبات إلى الـ API أن تحتوي على الهيدر التالي:

يمكنك الحصول على الـ API Token الخاص بك من صفحة حسابك.

نقاط النهاية المتاحة:

1. عرض رصيد المحفظة

الطريقة: GET

نقطة النهاية: /wp-json/custom-shop/v1/wallet-balance

الوصف: استرجاع رصيد المحفظة الحالي للمستخدم المصادق.

الاستجابة الناجحة (200):

{
    "balance": "100.00",
    "currency": "USD"
}

2. عرض المنتجات

الطريقة: GET

نقطة النهاية: /wp-json/custom-shop/v1/products

الوصف: استرجاع قائمة بالمنتجات المتاحة.

الاستجابة الناجحة (200):

[
    {
        "id": 123,
        "name": "اسم المنتج",
        "price": "50.00",
        "max_quantity": 10
    },
    {
        "id": 124,
        "name": "منتج آخر",
        "price": "75.00",
        "max_quantity": 5
    }
]

3. إنشاء طلب

الطريقة: POST

نقطة النهاية: /wp-json/custom-shop/v1/create-order

الوصف: إنشاء طلب جديد وخصم المبلغ من رصيد المحفظة.

المعلمات:

الاسم	الوصف	نوع البيانات	إلزامي
product_id	معرف المنتج	عدد صحيح	نعم
email_delivery	البريد الإلكتروني للتسليم	نص	نعم
quantity	الكمية المطلوبة (القيمة الافتراضية 1)	عدد صحيح	لا

مثال على الطلب:

{
    "product_id": 123,
    "email_delivery": "[email protected]",
    "quantity": 2
}

الاستجابة الناجحة (200):

{
    "success": true,
    "order_id": 456,
    "total_price": "100.00",
    "quantity": 2,
    "remaining_balance": "50.00"
}

4. الاستعلام عن حالة الطلب

الطريقة: GET

نقطة النهاية: /wp-json/custom-shop/v1/order-status/<order_id>

الوصف: استرجاع حالة الطلب ومعلوماته.

مثال على الطلب:

الاستجابة الناجحة (200):

{
    "order_id": 456,
    "status": "completed",
    "email_delivery": "[email protected]"
}

أكواد الأخطاء:

رمز الخطأ	الرسالة	الحالة
invalid_token	Invalid API token	401
missing_product	Product ID is required	400
invalid_email	يرجى إدخال بريد إلكتروني صحيح للتسليم	400
invalid_product	Product not found	404
insufficient_stock	الكمية المطلوبة غير متوفرة في المخزون	400
insufficient_funds	رصيد المحفظة غير كافي	400
wallet_debit_failed	فشل في خصم المبلغ من المحفظة	500
order_creation_failed	خطأ في إنشاء الطلب	500

ملاحظات:

• جميع الطلبات يجب أن تحتوي على الهيدر Api-Token مع قيمة التوكن الخاصة بك.
• تأكد من استخدام HTTPS لضمان أمان البيانات.
• في حالة وجود أي استفسارات أو مشاكل، يرجى التواصل مع فريق الدعم.