Guide du développeur de l’API The Wallet Crew

Créez des intégrations de Cartes Apple Wallet et Google Wallet avec l’API The Wallet Crew, notamment l’authentification, les mises à jour de Cartes, les webhooks, les scans et les rapports.

Guide développeur de l’API The Wallet Crew

Créez des intégrations de Carte pour Apple Wallet et Google Wallet avec The Wallet Crew. Ce guide couvre l’authentification API, les mises à jour de Carte, les webhooks, les scans, les rapports et les parcours qui prennent en charge chaque flux de travail.

Ouvrez la référence API

Exemples concrets

Créez une Carte de fidélité après l’inscription ou le paiement.
Mettez à jour les champs de la Carte après un événement CRM, de billetterie ou de POS.
Acheminez les événements du cycle de vie Wallet vers un back-end, un CRM ou une plateforme d’analytique.

Commencez ici

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

Obtenez les identifiants

Générez une clé d’API depuis la console d’administration, dans Paramètres → Sécurité → Clés API. Envoyez-la dans le X-API-KEY en-tête de chaque requête.

Ouvrez la référence API

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

Ouvrez la référence API

Effectuez une première requête

Commencez avec une Carte qui existe déjà plutôt qu’avec un flux de création. C’est le moyen le plus rapide de valider l’accès au tenant, l’authentification et le comportement de mise à jour sans mélanger la logique de création dans le premier test.

L’appel initial le plus courant est une mise à jour forcée de Carte. Il indique à la plateforme de récupérer à nouveau les données auprès des fournisseurs configurés, de reconstruire la Carte et de pousser la version mise à jour vers l’appareil :

PATCH /api/{tenantId}/passes?id={passId}
X-API-KEY: {api_key}
Content-Type: application/json

{
  "additionalData": { "loyaltyTier": "gold" },
  "options": { "updateMetadata": true }
}

Une Carte peut également être ciblée par un identifiant externe au lieu de passId, par exemple id.shopify.customerId={customerId}. Consultez Concepts clés pour connaître la différence entre les deux. Un 200 réponse signifie que la mise à jour s’est exécutée de manière synchrone ; 202 signifie qu’elle a été mise en file d’attente.

Si aucune Carte n’existe encore, commencez plutôt par les flux d’inscription ou la création de Carte déclenchée par un connecteur, puis revenez à cet appel une fois qu’une Carte a été émise.

Continuez avec Prise en main de l’API pour le guide complet.

Étendez 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 aux rapports.

Authentification

Certaines API à portée de tenant prennent en charge d’autres modèles d’authentification ou des scopes supplémentaires, par exemple le flux OAuth2 utilisé par certaines opérations administratives. Lorsque c’est le cas, le guide du point de terminaison ou la référence API 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 Carte, les webhooks, les scans et la référence API interactive.

Référence API

Utilisez la référence API lorsque la structure exacte du payload, le schéma de réponse ou le comportement du point de terminaison importe.

Ouvrez la référence API

Guides développeur

Ces guides couvrent les principaux schémas d’intégration.

Concepts clés couvre les tenants, les identifiants, les modèles et les bases du cycle de vie de la Carte.
Prise en main de l’API décrit la première requête à portée de tenant.
Flux d’inscription et Création de Carte déclenchée par un connecteur couvrent l’émission de nouvelles Cartes.
Mettre à jour les données de Carte dans les modèles explique comment afficher les données actuelles de la Carte.
Webhooks, API de scan, et API Insights couvrent les événements, les scans et les rapports.

Étapes suivantes courantes

Après la réussite de la première requête, l’étape suivante dépend généralement de l’objectif d’intégration.

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

FAQ

Comment créer une clé API ?

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 décrites dans « Commencez ici ».

Comment une clé API doit-elle être stockée ?

Conservez les clés API dans un stockage secret côté serveur. Ne les exposez pas dans le code du navigateur, les applications mobiles, les journaux ou le contrôle de source.

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

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

Quel est le meilleur premier appel 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 tenant, l’authentification et le chemin de mise à jour sans dépendre d’un flux de création.