AppetiteDevelopers
DashboardGet started

Getting started

The Appetite Developer Portal lets your organisation consume Appetite's analytics APIs across the restaurants you integrate with. This guide takes you from sign-up to your first authenticated request.

1. Create your organisation

Head to the sign-up page and create an account with your work email. You'll provide your name, your organisation's name, and a password.

2. Wait for approval

New organisations are reviewed by an Appetite admin before keys go live. While you're in the pending_approval state you'll see a holding screen — we'll email you the moment you're approved.

3. Create an API key

Once approved, open API keys and create a key. The full secret is shown once, at creation — copy it and store it securely. Keys are hashed at rest and can't be retrieved again.

4. Make your first request

Pass your key as a Bearer token in the Authorization header:

curl https://api.appetitepos.com.au/v1/usage \
  -H "Authorization: Bearer sk_live_your_key_here"

A successful response returns JSON:

{
  "totalRequests": 48213,
  "errorRate": 0.012,
  "daily": [{ "date": "2026-06-01", "requests": 1624, "errors": 18 }]
}

5. Connect a restaurant

Each restaurant owner grants your organisation access individually. Ask the owner for their restaurant code, then request access from the Restaurants page. Once they approve, that restaurant's data becomes available to your integration.

Next steps