This document provides a high-level overview of Misca APIs and how they are intended to be used alongside user and business flows.
Misca APIs are designed to:
- Support authenticated business operations
- Provide secure access to business data
- Serve public menu content to end-users
This documentation focuses on how APIs fit into real flows, not low-level endpoint details.
Misca APIs are logically separated into scopes:
Used for:
- User authentication
- Token issuance
- Public access support
These APIs are accessible without prior authentication where applicable.
Used for:
- Business creation and management
- Category and product operations
- Price updates and menu structure changes
All endpoints in this scope require authentication.
APIs should be consumed in the context of flows:
- Onboarding
- Business management
- Menu updates
Each flow references the APIs required to complete it, while detailed schemas are delegated to Swagger.
All APIs follow a consistent response structure:
isSuccessdatamessageerrors
This format is shared across all scopes.
API behavior may evolve over time.
Clients should rely on documented flows and Swagger definitions to stay compatible.
- To understand what to build: read flow documents
- To understand how to call APIs: use Swagger