API Documentation

Introduction

Welcome to the Digital Signage Management System API. This comprehensive API allows you to integrate with our platform for screen content management, order processing, and queue management. Our API is designed to be RESTful, secure, and easy to use.

Authentication

Most API endpoints require authentication. We support different authentication methods depending on the use case.

Screen Authentication

Digital screens use Bearer token authentication with their unique API token. This token is automatically generated when a screen is registered.

User Authentication

Authenticated users can access protected endpoints using their personal API tokens obtained through the dashboard.

Screen Content API

The Screen Content API allows digital displays to retrieve their scheduled content and report their status.

{
  "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"
        }
      }
    }
  ]
}

Order Management API

The Order API enables mobile ordering functionality for customers using QR codes.

{
  "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
}

Queue Management API

Manage queue services and counters for customer service operations.

Services Management

Counters Management

Content Types

The system supports various content types for digital signage displays.

Error Handling

The API uses standard HTTP status codes and returns detailed error messages.

Rate Limits

To ensure fair usage and system stability, we implement rate limiting on our API endpoints.

• Screen content requests: 60 per minute per screen
• Order placement: 10 per minute per IP
• OTP requests: 3 per hour per email

SDK Libraries

We provide official SDK libraries to simplify integration with our API.

Support & Help

Need help with API integration? Our support team is here to assist you.