توثيق API

المقدمة

مرحباً بك في نظام إدارة اللافتات الرقمية API. يتيح لك هذا API الشامل التكامل مع منصتنا لإدارة محتوى الشاشات ومعالجة الطلبات وإدارة الطوابير. تم تصميم API ليكون RESTful وآمن وسهل الاستخدام.

المصادقة

معظم نقاط نهاية API تتطلب المصادقة. نحن ندعم طرق مصادقة مختلفة حسب حالة الاستخدام.

مصادقة الشاشة

تستخدم الشاشات الرقمية مصادقة Bearer token مع رمز API الفريد الخاص بها. يتم إنشاء هذا الرمز تلقائياً عند تسجيل الشاشة.

مصادقة المستخدم

يمكن للمستخدمين المصادق عليهم الوصول إلى نقاط النهاية المحمية باستخدام رموز API الشخصية الخاصة بهم المحصل عليها من لوحة التحكم.

API محتوى الشاشة

يسمح API محتوى الشاشة للشاشات الرقمية باسترداد المحتوى المجدول وإبلاغ حالتهم.

{
  "screen_id": 1,
  "version_hash": "abc123def456",
  "schedules": [
    {
      "id": 1,
      "priority": 1,
      "is_active": true,
      "content": {
        "id": 1,
        "name": "Welcome Message",
        "content_type": "text_block",
        "duration": 10,
        "transition": "fade",
        "data": {
          "title": "Welcome to Our Restaurant",
          "content": "Enjoy your meal!",
          "text_color": "#000000",
          "background_color": "#ffffff"
        }
      }
    }
  ]
}

API إدارة الطلبات

يُمكّن API الطلبات وظيفة الطلب عبر الهاتف المحمول للعملاء باستخدام رموز QR.

{
  "qr_code_id": 1,
  "shop_id": 1,
  "customer_name": "John Doe",
  "customer_phone": "+966501234567",
  "table_number": "12",
  "notes": "No onions please",
  "items": [
    {
      "menu_item_id": 1,
      "quantity": 2,
      "price": 25.99
    },
    {
      "menu_item_id": 2,
      "quantity": 1,
      "price": 15.50
    }
  ]
}

{
  "success": true,
  "order_id": 123,
  "order_number": "ORD-20250101-ABC123",
  "message": "Order placed successfully",
  "estimated_time": 25
}

API إدارة الطوابير

إدارة خدمات الطوابير والعدادات لعمليات خدمة العملاء.

إدارة الخدمات

إدارة العدادات

أنواع المحتوى

يدعم النظام أنواع محتوى مختلفة لشاشات اللافتات الرقمية.

معالجة الأخطاء

يستخدم API رموز حالة HTTP القياسية ويعيد رسائل خطأ مفصلة.

حدود المعدل

لضمان الاستخدام العادل واستقرار النظام، نطبق تحديد المعدل على نقاط نهاية API الخاصة بنا.

• طلبات محتوى الشاشة: 60 في الدقيقة لكل شاشة
• تقديم الطلبات: 10 في الدقيقة لكل IP
• طلبات OTP: 3 في الساعة لكل بريد إلكتروني

مكتبات SDK

نقدم مكتبات SDK رسمية لتبسيط التكامل مع API الخاص بنا.

الدعم والمساعدة

تحتاج مساعدة في تكامل API؟ فريق الدعم لدينا هنا لمساعدتك.