Fidélité gère les programmes de fidélité : comptes de points, récompenses, règles de
gain, paliers (tiers), segments clients, et une surface membre (/me) pour l'appli
client final (carte de fidélité, QR).
- Base URL — prod :
https://loyalty.api.puwapi.com· dev :http://localhost:5600 - Auth : JWT + gating
loyalty.
Programme¶
Base : /api/loyalty/program
| Méthode | Route | Rôle |
|---|---|---|
| GET/PUT | /api/loyalty/program | Configuration du programme |
| GET/POST | /api/loyalty/program/tiers | Paliers de fidélité |
| PUT/DELETE | /api/loyalty/program/tiers/{id} | Modifier / supprimer un palier |
| GET/PUT | /api/loyalty/program/expiry | Politique d'expiration des points |
Récompenses & règles de gain¶
| Base | Méthodes |
|---|---|
/api/loyalty/rewards | GET, POST, PATCH {id}, DELETE {id} |
/api/loyalty/earning-rules | GET, POST, PUT {id}, DELETE {id} |
Comptes & transactions¶
Base : /api/loyalty
| Méthode | Route | Rôle |
|---|---|---|
| GET | /api/loyalty/accounts/{customerId} | Solde d'un client |
| POST | /api/loyalty/accounts/{customerId}/credit | Créditer des points (atomique) |
| POST | /api/loyalty/accounts/{customerId}/debit | Débiter des points (atomique) |
| GET | /api/loyalty/transactions | Historique |
| GET | /api/loyalty/customers/segments | Segments clients |
| POST | /api/loyalty/events/credit-requested | Demande de crédit (ex. via QR) |
Rachats (redemptions)¶
Base : /api/loyalty/redemptions
| Méthode | Route | Rôle |
|---|---|---|
| GET | /api/loyalty/redemptions | Lister |
| POST | /api/loyalty/redemptions/{id}/validate | Valider un rachat |
| POST | /api/loyalty/redemptions/{id}/cancel | Annuler |
| POST | /api/loyalty/redemptions/validate-by-code | Valider par code (en caisse) |
Surface membre (client final)¶
Base : /api/loyalty/me — pour l'application du client final, sur plusieurs commerçants.
| Méthode | Route | Rôle |
|---|---|---|
| POST | /api/loyalty/me/enroll/{tenantId} | S'inscrire au programme d'un commerçant |
| GET/PUT | /api/loyalty/me/profile | Profil |
| GET | /api/loyalty/me/accounts | Ses comptes de fidélité |
| GET | /api/loyalty/me/accounts/{tenantId}/transactions | Historique |
| GET | /api/loyalty/me/accounts/{tenantId}/rewards | Récompenses disponibles |
| POST | /api/loyalty/me/accounts/{tenantId}/rewards/{rewardId}/redeem | Échanger une récompense |
| GET | /api/loyalty/me/accounts/{tenantId}/coupons | Coupons |
| GET | /api/loyalty/me/qrcode, /api/loyalty/me/qr/refresh | QR de la carte (signé HMAC) |
| POST/DELETE | /api/loyalty/me/push-token[/{deviceId}] | Notifications push |
| GET/PUT | /api/loyalty/me/notifications/{tenantId} | Préférences |
Le crédit/débit de points est atomique ; le QR de la carte est signé HMAC pour éviter la falsification. Le SMS marketing est facturé à l'usage.