Loyalora API, as shipped in the download

Loyalora REST API, Webhooks & MCP (1.0)

Loyalora ships a JSON REST API, signed webhooks and an MCP endpoint, so the register can answer to whatever else you run — a till, a booking system, a workflow tool, or an assistant.

Everything below reads the same engine the screens read. **A balance is the sum of a customer's ledger entries and is stored nowhere**, so no response here can disagree with the card the customer is looking at.

Authentication

Authorization: Bearer apk_xxxx

Mint keys in Settings → API & Webhooks. A key belongs to a user and can do exactly what that user can do in the browser — the same four-rung ladder applies (viewer · clerk · manager · admin). Keys are stored as SHA-256 hashes and shown once.

Access: a key is created Read only or Read and write. A read-only key is refused on every non-GET request at the door, before any handler runs, with 403 forbidden.

Endpoints

Method	Path	What it does
GET	/api/ping	Verify the key; returns the user and the key's scope
GET	/api/customers	List customers with balances. ?q=, `?active=0\	1`
POST	/api/customers	Add a customer
GET	/api/customers/{id}	One customer: balance, per-programme split, recent ledger
POST	/api/customers/{id}/earn	Record activity and earn what it is worth
POST	/api/customers/{id}/redeem	Redeem a reward
GET	/api/rewards	Rewards and what they cost
GET	/api/openapi.json	OpenAPI 3.0 spec (imports as a custom connector)
GET	/healthz	Unauthenticated liveness probe

Earning: send what HAPPENED, not points

curl -X POST https://loyalty.example.com/api/customers/12/earn \
  -H "Authorization: Bearer apk_xxxx" -H 'Content-Type: application/json' \
  -d '{"program_id": 1, "amount": "24.99"}'

{ "ok": true, "entry_id": 4471, "points": 24, "program_id": 1, "balance": 962 }

Send amount (a decimal string) or amount_cents for a points-per-spend programme, or visits for a stamps programme. There is deliberately no field that sets a points figure. The programme's rate decides, and it rounds down. A spend too small to earn anything comes back 422 with the rate quoted — nothing is recorded, because a ledger full of zero-point rows teaches nobody anything.

Redeeming

curl -X POST https://loyalty.example.com/api/customers/12/redeem \
  -H "Authorization: Bearer apk_xxxx" -H 'Content-Type: application/json' \
  -d '{"reward_id": 3}'

A short balance comes back 409 conflict, not 422: the request was well-formed and the register said no. Retrying after the customer earns more is the right thing to do, and the status says so. The balance check and the write happen inside one lock, so it is safe to call this while somebody is redeeming at the counter — one of you wins, and it is never both.

Webhooks

POSTed as JSON on each subscribed event, signed:

X-Loyalora-Event: reward.redeemed
X-Loyalora-Signature: sha256=<hmac_sha256(body, secret)>

Event	Fires when
customer.created	a customer is added, from any door
points.earned	activity is recorded and points are credited
reward.redeemed	a reward is redeemed

One delivery attempt with a short timeout, logged either way. Build idempotent receivers.

Limits, honestly

• The API acts at user level; scope is read-only or full, on top of the app's roles.
• One delivery attempt per webhook event (log + idempotent receivers, not a retry queue).
• GET /api/customers caps at 200 rows.
• There is no endpoint that emails anybody, and no bulk anything. Loyalora has no campaign surface; see the README.
• Nothing can set a balance, over the API or anywhere else. The only ways it moves are earn, redeem and adjust — and adjust is manager-only and requires a reason.

MCP — the agent endpoint

Loyalora speaks the Model Context Protocol at POST /mcp, so Claude, ChatGPT agents, n8n's AI nodes or your own code can use the register instead of merely reading it. Same bearer key, same roles, same engine. An agent cannot do anything its key's user could not do in the browser — and it cannot invent points, because nothing can.

Transport is streamable HTTP, stateless: one JSON-RPC 2.0 request in, one JSON response out.

curl -s -X POST https://loyalty.example.com/mcp \
  -H "Authorization: Bearer apk_xxxx" -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"initialize",
       "params":{"protocolVersion":"2025-06-18","capabilities":{},"clientInfo":{"name":"my-agent","version":"1"}}}'

Then tools/list to discover, tools/call to act:

curl -s -X POST https://loyalty.example.com/mcp \
  -H "Authorization: Bearer apk_xxxx" -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":2,"method":"tools/call",
       "params":{"name":"customer_card","arguments":{"email":"mira@example.com"}}}'

Connect it to an assistant

Mint the key in the app first: Settings → API keys. Choose Read only when the assistant should answer questions but never change anything — the endpoint then lists only the read tools and refuses the rest by name, so a careless prompt cannot write. Full access behaves as before.

Every client needs the same three facts, and nothing in the handshake is vendor-specific:

The address	https://loyalty.example.com/mcp
The key	header Authorization: Bearer apk_xxxx
The transport	MCP over streamable HTTP, stateless

Claude — one command, or the same URL and header as a custom connector in the desktop and web apps:

claude mcp add --transport http loyalora https://loyalty.example.com/mcp \
  --header "Authorization: Bearer apk_xxxx"

ChatGPT and the OpenAI API — one entry in the Responses API's tools array (in ChatGPT itself, the same URL and key go in as a connector):

{
  "type": "mcp",
  "server_label": "loyalora",
  "server_url": "https://loyalty.example.com/mcp",
  "authorization": "apk_xxxx",
  "require_approval": "never"
}

Own Your AI reads a list of servers in this shape:

{
  "mcpServers": [
    { "id": "loyalora", "name": "Loyalora", "url": "https://loyalty.example.com/mcp",
      "token": "apk_xxxx", "enabled": true }
  ]
}

**Every other client spells the same three facts differently — copy the shape from its own documentation, not from here.** VS Code is the clearest example of why: its configuration reference (read 6 September 2026) puts servers in .vscode/mcp.json under a "servers" object — *"an object that maps server names to their configurations"* — not an mcpServers array. Pasted as-is, the block above will not load there. The id, the URL and the token are what travel; the JSON around them belongs to whichever client you are configuring.

A local model, n8n, or your own code — n8n's MCP Client node takes the URL and the same Authorization: Bearer header; a model running on your own machine reaches it through any MCP client, so nothing leaves your network at all. Writing it yourself is one POST of JSON-RPC 2.0:

curl -X POST https://loyalty.example.com/mcp \
  -H "Authorization: Bearer apk_xxxx" -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'

Any client that speaks MCP's streamable-HTTP transport works, including ones that do not exist yet: Loyalora implements the protocol, not an integration with a particular vendor.

Tools

Tool	Writes?	What it does
find_customer	no	Find people by name, email or phone, with balances
customer_card	no	One card in full: balance per programme, what they can afford, what the next reward still needs, and the ledger
list_rewards	no	Rewards and what they cost
list_programs	no	The programmes, how each earns, and what each owes
outstanding_liability	no	Points issued, redeemed and outstanding, overall and per programme
record_activity	yes	Record a spend or a visit; the programme's rate decides the points
redeem_reward	yes	Redeem a reward; refused when the balance is short

There is deliberately no adjust tool, no delete tool and no send-mail tool. Creating points from nothing, destroying a record and writing to a customer all stay human clicks in the app. An agent can tell you who is one coffee away and record what happened at the counter — it cannot mint points or email your customers.

What an agent must not assume

• You cannot set a balance. There is no field for it anywhere. Record what happened instead.
• A refusal is the register working. "Not enough points" is the correct answer to a redemption the customer cannot afford; report it, do not retry with a different reward unless asked.
• The ledger is the truth. If a balance looks wrong, customer_card returns the history that produced it — read that rather than assuming the number is stale.