Skip to main content

REST API Examples

Olympus Cloud is a REST API — no SDK installation required. You can call it from any language or tool that supports HTTP requests.

Base URLs

EnvironmentBase URL
Productionhttps://api.olympuscloud.ai/v1
Staginghttps://staging.api.olympuscloud.ai/v1
Developmenthttps://dev.api.olympuscloud.ai/v1

Authentication

All authenticated endpoints require a JWT Bearer token in the Authorization header:

Authorization: Bearer <access_token>

Tokens are obtained via the Authentication endpoints (POST /v1/auth/login or POST /v1/auth/staff/pin).

Content Type

All request and response bodies use JSON:

Content-Type: application/json

Quick Example

# 1. Login to get a token
TOKEN=$(curl -s -X POST https://dev.api.olympuscloud.ai/v1/auth/login \
-H "Content-Type: application/json" \
-d '{"email": "manager@demo-restaurant.com", "password": "DevPassword123!"}' \
| jq -r '.status.access_token')

# 2. Use the token to create an order
curl -X POST https://dev.api.olympuscloud.ai/v1/commerce/orders \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-d '{
"source": "pos",
"currency": "USD",
"items": [
{"name": "Margherita Pizza", "quantity": 1, "unit_price": 14.99}
]
}'

Guides

GuideDescription
AuthenticationJWT login, token refresh, staff PIN auth, OAuth/SSO
OrdersCreate, read, update, and track orders
MenusBrowse menus, categories, and items
TablesTable management and floor plan
Kitchen (KDS)Kitchen display system operations
PaymentsProcess payments and refunds
ReservationsCreate and manage reservations
AI GatewayAI chat, recommendations, and TTS
WebhooksEvent subscriptions and webhook integration
ErrorsStandard error response format

Language Examples

Every guide includes examples in:

  • curl — for quick testing
  • Python — using requests
  • JavaScript — using fetch
  • Go — using net/http