Lotus
Type to search documentation.

API Reference

Introduction

Reference documentation for Cafe API 1.0.0, covering 12 operations and 1 webhook.

Overview

A demo API for cafe operators (not customers) to manage menus, orders, and revenue. This demo was generated from Redocly’s cafe.yaml example and adapted for Prosefly. It is a Prosefly Pro feature for demonstrating a realistic OpenAPI workflow, including API credentials, menu management, orders, and revenue statistics.

Endpoint pages are grouped by resource in the left sidebar. Each endpoint page documents the HTTP method, path, parameters, request body content types, and response status codes extracted from the OpenAPI document.

Servers

  • https://cafe.cloud.redocly.com - Demo server for the Cafe API.

Authentication

The specification defines these shared authentication schemes. Endpoint-specific requirements come from each operation security field.

OAuth2

Type: oauth2

OAuth2 authorization for API access.

authorizationCode

  • Authorization URL: https://cafe.cloud.redocly.com/oauth2/authorize
  • Token URL: https://cafe.cloud.redocly.com/oauth2/token

Scopes:

  • menu:read - Read access to menu items and images
  • menu:write - Write access to menu items (create, delete)
  • orders:read - Read access to orders
  • orders:write - Write access to orders (create, update, delete)

clientCredentials

  • Token URL: https://cafe.cloud.redocly.com/oauth2/token

Scopes:

  • menu:read - Read access to menu items and images
  • menu:write - Write access to menu items (create, delete)
  • orders:read - Read access to orders
  • orders:write - Write access to orders (create, update, delete)

ApiKey

Type: apiKey

API key for internal operations.

  • Location: header
  • Parameter: X-API-Key

Endpoints

Use the API Reference sidebar to browse endpoint pages. The generated sidebar currently includes:

  • Authorization: 1 endpoints
  • Orders: 6 endpoints
  • Products: 4 endpoints
  • Statistics: 1 endpoints