Guide du développeur

Commencez avec les API de The Wallet Crew, l’authentification et les principaux parcours d’intégration.

Guide développeur

Cette section se concentre sur les intégrations API avec The Wallet Crew. Elle couvre l'authentification, la référence API, une première requête et les principaux parcours à suivre ensuite.

Ouvrir la référence API Démarrer le guide de démarrage rapide

Exemples concrets

• Créer une Carte de fidélité après l'inscription ou le paiement.
• Mettre à jour les champs de la Carte après un événement CRM, de billetterie ou de point de vente.
• Transférer les événements du cycle de vie du Wallet vers un backend, un CRM ou une stack d'analytique.

Commencez ici

La plupart des projets de développement suivent le même parcours.

1

Obtenir des identifiants

Générez une clé API depuis la console d'administration dans Paramètres → Sécurité → Clés API.

Pour la plupart des premières intégrations, la clé API est envoyée dans le X-API-KEY en-tête.

2

Ouvrir la référence de l’API

Utilisez la référence API pour examiner les points de terminaison, les corps de requête, les schémas de réponse et des exemples en direct.

Ouvrir la référence API

3

Effectuer une première requête

Commencez avec une Carte existante. C'est la façon la plus rapide de valider l'accès au locataire, l'authentification et le comportement de mise à jour sans mêler la logique de création au premier test.

Continuer avec Démarrer avec l’API.

4

Étendre l'intégration

Une fois que le premier appel de gestion fonctionne, passez aux flux de création, aux mises à jour, aux webhooks, aux scans et au reporting.

Authentification

Le principal point d'entrée développeur utilise une clé API. Générez la clé depuis la console d'administration, puis envoyez-la dans le X-API-KEY en-tête.

X-API-KEY: YOUR_API_KEY

Certaines API à portée du locataire peuvent utiliser d'autres modèles d'authentification ou des portées supplémentaires. Lorsque cela se produit, le guide du point de terminaison ou la référence fait foi.

Pour une première intégration, commencez par les API documentées autour de X-API-KEY. C'est le parcours habituel pour la gestion de la Carte, les webhooks, les scans et la référence API interactive.

Démarrage rapide

Le flux de validation le plus rapide consiste à commencer avec une Carte déjà existante, déclencher un appel de gestion, puis confirmer le résultat sur cette Carte.

L'appel initial le plus courant est une actualisation de la Carte :

PATCH /api/{tenantId}/passes

Cela valide la portée du locataire, l'authentification par clé API et le pipeline de mise à jour sur une Carte réelle. Utilisez Démarrer avec l’API pour la configuration de bout en bout.

Si aucune Carte n'existe encore, commencez par Flux d’inscription ou Création de Carte déclenchée par le connecteur.

Référence de l’API

Utilisez la référence API lorsque la forme exacte de la charge utile, le schéma de réponse ou le comportement du point de terminaison importent.

Principaux points d'entrée

• Référence de l’API
• Webhooks

Guides développeur

Ces pages couvrent les principaux modèles d'intégration.

• Concepts clés pour la portée du locataire, les identifiants, les modèles et les bases du cycle de vie de la Carte.
• Démarrer avec l’API pour les premiers appels à portée du locataire sur des Cartes qui existent déjà.
• Flux d’inscription pour la création de Cartes lors des parcours d'inscription hébergés ou personnalisés.
• Création de Carte déclenchée par le connecteur pour l'émission pilotée par la source, basée sur les événements en amont.
• Mettre à jour les données de la Carte dans les modèles pour mettre à jour les données de la Carte et les afficher dans les modèles.
• Moteur de modèles pour la syntaxe DotLiquid prise en charge, les filtres personnalisés et la minify balise.
• Webhooks pour la livraison d'événements en temps réel.
• API de scan pour l'ingestion des scans de codes-barres et QR.
• API Insights pour les requêtes sur les journaux, les événements et les métriques.
• Connecteurs personnalisés pour la logique d'intégration côté locataire.

Étapes suivantes courantes

Une fois la première requête réussie, l'étape suivante dépend généralement de l'objectif d'intégration.

• Si des Cartes existent déjà, commencez par Démarrer avec l’API.
• Si l'émission de Carte démarre lors d'une inscription, d'un paiement ou d'un formulaire hébergé, utilisez Flux d’inscription.
• Si l'émission de Carte démarre à partir d'un événement du système source, utilisez Création de Carte déclenchée par le connecteur.
• Pour garder le contenu du Wallet à jour, continuez avec Mettre à jour les données de la Carte dans les modèles.
• Pour notifier d'autres systèmes en temps réel, utilisez Webhooks.

FAQ

Comment récupérer l'authentification ?

Générez une clé API depuis la console d'administration, puis envoyez-la dans X-API-KEY pour les principales API de la plateforme documentées dans le flux de démarrage rapide.

Où se trouve la référence API ?

Utilisez Référence de l’API pour le principal point d'entrée API.

Quel est le meilleur premier appel à l’API ?

Une mise à jour forcée d'une Carte existante est généralement le meilleur premier appel, car elle valide l'accès au locataire, l'authentification et le chemin de mise à jour sans dépendre d'un flux de création.