Pour les développeurs

L’API loyal pour les caisses, les boutiques en ligne et vos propres systèmes

Une API REST avec clé API : votre caisse crédite tampons et points, votre boutique en ligne déclare les commandes, votre système inscrit des clients et valide les cartes. Tous les endpoints sont décrits dans la documentation.

Ouvrir la documentation API Clés API dans le portail

Documentation en anglais, en libre accès sans connexion

Exemple tiré de la documentation : points sur le chiffre d’affaires en caisse (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 à 1 point par euro

Ce que vous connectez via l’API

loyal COMMERCE : des points en ligne et en magasin

Votre boutique en ligne déclare les commandes payées ; chaque numéro de commande n’est crédité qu’une seule fois et les annulations retirent les points. Les points deviennent des codes de bon d’achat que votre boutique vérifie et invalide. Avec loyal COMMERCE en mode chiffre d’affaires, votre caisse crédite les ventes du magasin sur le même compte de points.

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

Section loyal COMMERCE dans la documentation

Connexion à la caisse : créditer et valider des tampons

Votre caisse crédite des tampons, consulte le solde d’une carte et valide les cartes complètes. Vous inscrivez les nouveaux clients avec leur adresse e-⁠mail ; la réponse contient l’identifiant client pour tous les appels suivants.

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

Démarrage caisse dans la documentation

Gérer vous-même les clés API

Vous créez les clés vous-même dans le portail, avec le rôle POS (caisse) ou ADMIN. La clé complète ne s’affiche qu’une fois, puis masquée. Pour en changer, créez-en une nouvelle et désactivez l’ancienne. Chaque requête l’envoie dans l’en-tête X-API-Key.

X-API-Key

Authentification dans la documentation

Connecter votre caisse en quatre étapes

Créer une clé API avec le rôle POS dans le portail.
Inscrire des clients : POST /user avec l’adresse e-⁠mail.
Créditer des tampons : POST /transaction.
Valider les cartes complètes : POST /redeem.

Ouvrir la documentation API Clés API dans le portail