Getting Started
Getting Started
Create an API key and make your first Panoptes API call.
Panoptes is a production-based restaurant operating system. Its API reaches every action a user can take in the dashboard — POS, kitchen display, menu and catalog, inventory and production, purchasing, delivery channels, cash and loss control, accounting, HR and payroll, and reports — and tells you about every change through signed webhooks.
1. Create an API key
- Sign in to the Panoptes dashboard as an owner (or a user with
manage_api_keys). - Open Developers → API keys and choose New key.
- Pick the scopes the integration needs. Prefer a module preset (
preset:pos,preset:inventory, …) overpreset:full. - Copy the key. It looks like
pnp_live_1a2b3c4d.<secret>and is shown once.
2. Pick an environment
| Environment | Base URL |
|---|---|
| Staging | https://staging-api.panoptesos.com |
| Production | https://api.panoptesos.com |
Build and test against staging first. Keys are per install — a staging key does not work in production.
3. Make a call
curl -s "https://staging-api.panoptesos.com/api/v1/public/items?limit=10" \
-H "X-Api-Key: pnp_test_1a2b3c4d.YOUR_SECRET"
{ "ok": true, "data": [{ "id": "…", "name": "Chicken shawarma", "price": 4500 }], "total": 42 }
4. Go further
- Console routes (
/api/v1/console/**) are the full API. A key calls any of them when it holds the matchingcap:<capability>scope — see Permissions & Scopes. - Webhooks push every audited change to your endpoint — see Webhooks.
- MCP lets an AI agent read facts and perform actions — see MCP / AI Agents.
- Use the Try it console on any endpoint in the API Reference, or import the Postman collection.