For developers

The loyal API for POS systems, online shops and your own software

A REST API with API keys: your POS books stamps and points, your online shop reports orders, your system registers customers and redeems cards. Every endpoint is described in the documentation.

Open API documentation API keys in the portal

Documentation in English, publicly available without login

Example from the documentation: revenue points at the till (loyal COMMERCE)

POST /transaction/revenue
Host: api.loyal-app.de
X-API-Key: your-api-key-here
Content-Type: application/json

{ "userId": "1234567890123",
  "totalCents": 2490 }

→ 24 points at 1 point per euro

What you can connect via the API

loyal COMMERCE: points from your online shop and store

Your online shop reports paid orders, each order number is booked exactly once, and cancellations reverse the points. Points turn into voucher codes that your shop checks and redeems. With loyal COMMERCE in revenue mode, your POS books in-store revenue to the same points account.

POST /shop/orders
POST /shop/orders/{orderId}/cancel
POST /shop/redeem
POST /transaction/revenue

loyal COMMERCE section in the docs

POS integration: award and redeem stamps

Your POS awards stamps, checks a card’s balance and redeems full cards. Register new customers with their email address; the response contains the customer ID for all further calls.

POST /user
POST /transaction
GET /user
POST /redeem

POS getting started in the docs

Manage API keys yourself

Create keys yourself in the portal, with the role POS (till) or ADMIN. The full key is shown only once, masked afterwards. To rotate, create a new key and deactivate the old one. Every request sends it in the X-API-Key header.

X-API-Key

Authentication in the docs

Connect your POS in four steps

Create an API key with the role POS in the portal.
Register customers: POST /user with their email address.
Award stamps: POST /transaction.
Redeem full cards: POST /redeem.

Open API documentation API keys in the portal