Points de terminaison Cartes
Lister les cartes de fidélité, voir les détails des cartes et récupérer les récompenses disponibles.
/api/v1/cashback/
Lister les Cartes
/api/v1/cashback/cards
Lister toutes les cartes de fidélité accessibles par cette clé API.
Quand l'utiliser
Appelez ce point de terminaison lorsque vous devez :
- Afficher une liste de programmes de fidélité aux clients
- Obtenir des identifiants de carte pour les utiliser dans d'autres points de terminaison
- Vérifier quelles cartes votre clé API peut accéder
Réponse
{
"success": true,
"data": {
"cards": [
{
"id": 5,
"unique_identifier": "abc123",
"name": "Récompenses Café",
"head": "Gagnez des points à chaque achat",
"is_active": true,
"points_per_currency": 1,
"currency_unit_amount": 1.00,
"club_id": 10
}
],
"total": 1
}
}Obtenir les Infos d'une Carte
/api/v1/cashback/cards/{card_id}
Obtenir des informations détaillées sur une carte de fidélité spécifique.
Paramètre d'URL : card_id (entier, requis) - L'ID de la carte
Champs de Réponse
| Champ | Type | Description |
|---|---|---|
id |
entier | Identifiant unique de la carte |
name |
chaîne | Nom d'affichage de la carte |
points_per_currency |
entier | Points gagnés par unité de devise |
currency_unit_amount |
décimal | Montant en devise pour le calcul des points |
is_active |
booléen | Si la carte est actuellement active |
Lister les Récompenses de Carte
/api/v1/cashback/cards/{card_id}/rewards
Obtenir toutes les récompenses actives disponibles pour une carte spécifique.
Étape par Étape : Afficher les Récompenses
Récupérer la Liste des Récompenses
Appelez ce point de terminaison avec votre card_id pour obtenir les récompenses disponibles.
Afficher au Membre
Affichez les noms des récompenses, les coûts en points et les descriptions au membre.
Gérer l'Échange
Lorsqu'un membre sélectionne une récompense, utilisez les points de terminaison Réclamations pour traiter l'échange.
Réponse
{
"success": true,
"data": {
"card_id": 5,
"rewards": [
{
"id": 1,
"name": "Café Gratuit",
"title": {"en": "Free Coffee", "fr": "Café Gratuit"},
"points": 100,
"reward_type": "discount",
"is_active": true
},
{
"id": 2,
"name": "20% de Réduction",
"title": {"en": "20% Off Next Purchase", "fr": "20% de réduction sur le prochain achat"},
"points": 200,
"reward_type": "percentage_discount",
"is_active": true
}
],
"total": 2
}
}