Für Entwickler

Die loyal API für Kassen, Onlineshops und eigene Systeme

Eine REST-API mit API-Schlüssel: Ihre Kasse bucht Stempel und Punkte, Ihr Onlineshop meldet Bestellungen, Ihr System registriert Kunden und löst Karten ein. Alle Endpunkte sind in der Dokumentation beschrieben.

API-Dokumentation öffnenAPI-Schlüssel im Portal

Dokumentation auf Englisch, frei zugänglich ohne Login

Beispiel aus der Dokumentation: Umsatzpunkte an der Kasse (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 Punkte bei 1 Punkt pro Euro

Was Sie über die API anbinden

loyal COMMERCE: Punkte aus Onlineshop und Laden

Ihr Onlineshop meldet bezahlte Bestellungen, gebucht wird genau einmal je Bestellnummer, Stornos buchen die Punkte zurück. Aus Punkten werden Gutscheincodes, die Ihr Shop prüft und entwertet. Mit loyal COMMERCE im Umsatzmodus bucht Ihre Kasse den Umsatz im Laden auf dasselbe Punktekonto.

  • POST /shop/orders
  • POST /shop/orders/{orderId}/cancel
  • POST /shop/redeem
  • POST /transaction/revenue
Abschnitt loyal COMMERCE in der Doku

Kassen-Anbindung: Stempel buchen und einlösen

Ihre Kasse vergibt Stempel, fragt den Stand einer Karte ab und löst volle Karten ein. Neue Kunden registrieren Sie mit ihrer E-⁠Mail-Adresse, die Antwort enthält die Kunden-ID für alle weiteren Aufrufe.

  • POST /user
  • POST /transaction
  • GET /user
  • POST /redeem
Einstieg Kassen-Anbindung in der Doku

API-Schlüssel selbst verwalten

Schlüssel erzeugen Sie selbst im Portal, mit der Rolle POS (Kasse) oder ADMIN. Der vollständige Schlüssel erscheint nur einmal, danach maskiert. Zum Wechseln legen Sie einen neuen an und deaktivieren den alten. Jede Anfrage trägt ihn im Header X-API-Key.

  • X-API-Key
Authentifizierung in der Doku

Kasse anbinden in vier Schritten

  1. API-Schlüssel mit der Rolle POS im Portal erzeugen.
  2. Kunden registrieren: POST /user mit der E-⁠Mail-Adresse.
  3. Stempel buchen: POST /transaction.
  4. Volle Karten einlösen: POST /redeem.
API-Dokumentation öffnenAPI-Schlüssel im Portal