Documentation

Centre d'aide Yaspass

Tout ce qu'il faut savoir pour démarrer, configurer et optimiser votre programme de fidélité.

Pour les commerçants

01

Créer votre compte

Rendez-vous sur yaspass.com/register. Renseignez le nom de votre établissement, votre e-mail et choisissez votre formule. Votre tableau de bord est disponible immédiatement.

02

Configurer votre carte de fidélité

Dans Dashboard > Fidélité > Créer un programme, définissez le nombre de tampons requis, la récompense, les couleurs et le logo de votre carte. La prévisualisation Apple/Google Wallet est en temps réel.

03

Ajouter des tampons

Partagez votre QR code unique avec vos clients. Lorsqu'un client le scanne, il s'inscrit automatiquement et reçoit son premier tampon. Vous pouvez aussi ajouter des tampons manuellement depuis Dashboard > Clients.

04

Envoyer des notifications

Dans Marketing > Notifications, rédigez votre message push et sélectionnez votre audience (tous les clients, segment spécifique). Les notifications arrivent directement sur l'écran de verrouillage via Apple/Google Wallet.

05

Lire vos analytics

Dashboard > Analytics affiche : nouveaux clients par semaine, taux de rétention, tampons distribués, récompenses échangées, et les heures de pointe de fréquentation. Export CSV disponible.

Pour les développeurs

API Reference complète →

Authentification

L'API Yaspass utilise des tokens JWT Bearer. Obtenez votre token via POST /auth/login avec vos identifiants. Le token expire après 24h. Incluez-le dans chaque requête : Authorization: Bearer <token>.

curl -X POST https://api.yaspass.com/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"vous@exemple.com","password":"votre_mdp"}'

Rate limiting

Les endpoints publics sont limités à 100 req/min. Les endpoints authentifiés acceptent 1 000 req/min. En cas de dépassement, l'API retourne un statut 429 avec un header Retry-After.

# Headers de réponse
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 847
X-RateLimit-Reset: 1748700000

Format des réponses

Toutes les réponses sont en JSON. Les succès retournent { data: {...}, meta: {...} }. Les erreurs retournent { error: { code: string, message: string } }.

# Succès
{ "data": { "id": "biz_123", "name": "Le Café du Coin" }, "meta": { "timestamp": "2026-05-14T10:00:00Z" } }

# Erreur
{ "error": { "code": "NOT_FOUND", "message": "Business not found" } }

Une question non couverte dans la doc ?

Contacter le support