API Reference

API REST Yaspass

Base URL : https://api.yaspass.com/v1 — Authentification Bearer JWT requise sur les endpoints protégés.

POST/auth/loginAuthentification — retourne un token JWT valide 24h.

Request body

{ "email": "user@exemple.com", "password": "motdepasse" }

Response

{ "data": { "token": "eyJhbGci...", "expiresAt": "2026-05-15T10:00:00Z" } }
POST/auth/registerCréation de compte commerçant.

Request body

{ "email": "user@exemple.com", "password": "motdepasse", "name": "Jean Dupont" }

Response

{ "data": { "id": "usr_abc123", "email": "user@exemple.com" } }
GET/businesses🔒 Auth requiseListe tous les établissements de l'utilisateur authentifié.

Response

{ "data": [{ "id": "biz_xyz", "name": "Le Café du Coin", "slug": "le-cafe-du-coin" }] }
POST/loyalty/scan-enroll🔒 Auth requiseInscrit un client au programme de fidélité via scan QR.

Request body

{ "businessId": "biz_xyz", "customerPhone": "+33612345678" }

Response

{ "data": { "customerId": "cust_001", "enrolled": true, "stamps": 1 } }
POST/loyalty/add-stamp🔒 Auth requiseAjoute un ou plusieurs tampons à un client.

Request body

{ "customerId": "cust_001", "businessId": "biz_xyz", "count": 1 }

Response

{ "data": { "stamps": 4, "total": 10, "rewardReady": false } }
GET/loyalty/customers🔒 Auth requiseListe les clients fidélité d'un établissement.

Response

{ "data": [{ "id": "cust_001", "phone": "+33612345678", "stamps": 4, "createdAt": "2026-04-01" }], "meta": { "total": 142, "page": 1 } }
GET/analytics/business/:id🔒 Auth requiseAnalytics d'un établissement : nouveaux clients, tampons, récompenses.

Response

{ "data": { "newCustomers": 23, "activeCustomers": 142, "stampsThisWeek": 87, "rewardsRedeemed": 5 } }
POST/notifications/send🔒 Auth requiseEnvoie une notification push à un segment de clients.

Request body

{ "businessId": "biz_xyz", "title": "Offre spéciale !", "body": "Venez profiter de -20% ce weekend.", "segment": "all" }

Response

{ "data": { "sent": 142, "failed": 0, "jobId": "job_notif_abc" } }
POST/wallet/generate-pass🔒 Auth requiseGénère un pass Apple Wallet ou Google Wallet pour un client.

Request body

{ "customerId": "cust_001", "type": "apple" }

Response

{ "data": { "passUrl": "https://api.yaspass.com/passes/abc123.pkpass", "expiresAt": null } }
Besoin d'un endpoint spécifique ? Contactez notre équipe à api@yaspass.com. Les clés API dédiées (sans expiration) sont disponibles sur le plan Agence.