Dla programistów

API loyal dla kas, sklepów internetowych i własnych systemów

REST API z kluczem API: kasa nalicza pieczątki i punkty, sklep internetowy zgłasza zamówienia, a Państwa system rejestruje klientów i realizuje karty. Wszystkie endpointy są opisane w dokumentacji.

Otwórz dokumentację APIKlucze API w portalu

Dokumentacja po angielsku, dostępna bez logowania

Przykład z dokumentacji: punkty za obrót w kasie (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 punkty przy 1 punkcie za euro

Co można podłączyć przez API

loyal COMMERCE: punkty ze sklepu internetowego i stacjonarnego

Sklep internetowy zgłasza opłacone zamówienia, każdy numer zamówienia jest księgowany dokładnie raz, a anulowanie odejmuje punkty. Punkty zamieniają się w kody bonów, które sklep sprawdza i unieważnia. Z loyal COMMERCE w trybie obrotu kasa nalicza obrót ze sklepu stacjonarnego na to samo konto punktowe.

  • POST /shop/orders
  • POST /shop/orders/{orderId}/cancel
  • POST /shop/redeem
  • POST /transaction/revenue
Sekcja loyal COMMERCE w dokumentacji

Integracja z kasą: naliczanie i realizacja pieczątek

Kasa nalicza pieczątki, sprawdza stan karty i realizuje pełne karty. Nowych klientów rejestrują Państwo adresem e-⁠mail, odpowiedź zawiera ID klienta do wszystkich kolejnych wywołań.

  • POST /user
  • POST /transaction
  • GET /user
  • POST /redeem
Pierwsze kroki z kasą w dokumentacji

Samodzielne zarządzanie kluczami API

Klucze tworzą Państwo samodzielnie w portalu, z rolą POS (kasa) lub ADMIN. Pełny klucz jest widoczny tylko raz, potem zamaskowany. Aby go wymienić, wystarczy utworzyć nowy i dezaktywować stary. Każde żądanie przesyła go w nagłówku X-API-Key.

  • X-API-Key
Uwierzytelnianie w dokumentacji

Integracja kasy w czterech krokach

  1. Utworzenie w portalu klucza API z rolą POS.
  2. Rejestracja klientów: POST /user z adresem e-⁠mail.
  3. Naliczanie pieczątek: POST /transaction.
  4. Realizacja pełnych kart: POST /redeem.
Otwórz dokumentację APIKlucze API w portalu