API Reference & Model Context Protocol Spec
Designed strictly for developers, agent architects, and software engineers. Authenticate API calls, integrate MCP tools into LLM workflows, and subscribe to restaurant events.
Authentication
All REST API requests and MCP tool executions must include an Authorization bearer header containing a secret API key.
Granular Permission Scopes:
orders:read - Read orders & tabsorders:write - Create & mutate ordersfiscal:write - Emit DGII tax vouchersanalytics:read - Access financial metrics/api/v1/ordersCreates a new ticket and immediately dispatches it to KDS and POS print queues.
{
"table_number": "Mesa 04",
"dining_option": "dine_in",
"items": [
{
"product_id": "prod_ribeye_12oz",
"quantity": 1,
"unit_price": 1250.00,
"notes": "Término medio, sin cebolla"
}
],
"customer_rnc": "1-01-00244-1",
"apply_legal_tip": true
}Model Context Protocol (MCP 2024-11-05)
BrazzaOS natively implements the Model Context Protocol standard over SSE. This empowers autonomous agents to query stock, inspect registers, and generate audit reports.
{
"mcpServers": {
"brazzaos": {
"command": "npx",
"args": ["-y", "@brazzaos/mcp-server"],
"env": {
"BRAZZA_API_KEY": "brazza_live_your_secret_key_here",
"BRAZZA_SERVER_URL": "https://brazza.app/api/mcp"
}
}
}
}Exposed MCP Tools:
Calculates gross revenue, taxes, legal tip, and food margins.
Inspects register shift and calculates blind drop variances.
Fetches all live orders across dining room, delivery, and QR.
Returns raw ingredients below minimum reorder thresholds.
Webhooks & HMAC Verification
Webhooks sent to your endpoints include an X-Brazza-Signature header (alongside X-Onyx-Signature for backward compatibility) containing an HMAC SHA256 digest computed with your webhook secret.