Skip to content

concepts.md

Latest commit

 

History

History
90 lines (63 loc) · 2.56 KB

concepts.md

File metadata and controls

90 lines (63 loc) · 2.56 KB

Concepts

This section explains the core concepts and terminology used across the Misca platform. Understanding these concepts will help you better follow user flows and API usage.

Misca

Misca is a digital menu and business management platform designed for cafés, restaurants, and similar businesses. It allows businesses to manage their menu, products, and public-facing menu pages while providing APIs for integration.

User

A User represents a person who can authenticate into the system.
Users can:

  • Create and manage one or more businesses
  • Access workspace and panel features
  • Interact with protected APIs

Business

A Business represents a café, restaurant, or similar entity.
Each business has:

  • A unique name and slug
  • Branding information (logo, address, location)
  • One or more menus visible to end-users

A user can own or manage multiple businesses.

Workspace

The Workspace is the authenticated area where users manage their businesses.
It includes:

  • Listing owned businesses
  • Creating new businesses
  • Selecting a business to manage

Workspace routes are not public and are not indexed by search engines.

Panel

The Panel is the business-specific management area.
After selecting a business, the user enters its panel to:

  • Manage categories
  • Manage products
  • Update prices
  • Control menu structure and order

Each panel is scoped to a single business.

Category

A Category is used to group products inside a menu.
Categories:

  • Belong to a specific business
  • Have a display order that affects menu rendering
  • Are managed through the business panel

Product

A Product represents a menu item.
Products:

  • Belong to a category
  • Have a name, price, and optional image
  • Can be created, updated, deleted, or repriced

Menu (Public)

The Menu is the public-facing page that end-users see.
It:

  • Is accessible via a business-specific URL
  • Is commonly accessed through QR codes
  • Displays categories and products in defined order

This page is optimized for end-users, not business owners.

Authentication

Misca uses JWT Bearer authentication for protected APIs.

  • Tokens have an expiration time
  • Expiration is provided as a Unix timestamp
  • Token lifetime is configurable and not hard-coded

Public menu access does not require authentication.

API

Misca provides multiple API scopes:

  • Public / Auth – authentication and end-user access
  • Workspace / Panel – business management APIs
  • Admin – administrative APIs

Detailed request and response schemas are documented in Swagger.