Hooks d’installation et de désinstallation de Carte

Créez un connecteur personnalisé qui appelle une API externe lorsqu’une carte est installée ou désinstallée dans Apple Wallet ou Google Wallet.

Il est possible de créer un connecteur personnalisé dans The Wallet Crew pour appeler une API externe chaque fois qu'une Carte est installée ou désinstallée sur Apple Wallet ou Google Wallet.

Cela permet aux marques de synchroniser l'état d'installation avec des systèmes externes tels qu'un CRM, un outil d'analyse ou une plateforme d'automatisation marketing.

Exemples concrets

• Une marque de vente au détail met à jour un champ CRM comme hasWalletPass=true juste après l'installation. Elle cesse ensuite d'envoyer des rappels « ajouter au Wallet ».

• Une marque de billetterie consigne les installations et désinstallations dans sa pile BI. Elle surveille l'adoption par événement, canal et type d'appareil.

• Une marque déclenche un parcours de bienvenue après l'installation. Elle utilise registrationSource pour segmenter par campagne UTM.

• Une marque détecte des pics inhabituels de désinstallation après une mauvaise version. Elle effectue rapidement un retour en arrière et communique de manière proactive.

Hooks d'exécution

La plateforme expose les hooks suivants sur le runtime.wallet.passUpdater point de terminaison :

• OnPassInstalled → Déclenché lorsqu'une Carte est ajoutée à Apple/Google Wallet

• OnPassUninstalled → Déclenché lorsqu'une Carte est supprimée d'Apple/Google Wallet

La même runtime.wallet.passUpdater inscription expose également quatre hooks autour de la création et de la mise à jour de Carte — OnPassCreating, OnPassCreated, OnPassUpdating, OnPassUpdated. Ils ne sont pas traités sur cette page, qui se concentre sur le duo installation/désinstallation. Voir Connecteurs personnalisés → Ce que fait cette inscription pour l'ensemble complet.

Les deux méthodes reçoivent les mêmes paramètres :

Paramètre	Type	Description
passId	chaîne	Identifiant unique de la Carte
passType	chaîne	Type de Carte (fidélité, carte cadeau, billet d'événement…)
identifiers	Record<string, any>	Identifiants clé/valeur définis sur la Carte (par ex. customerId)
appareil	"apple" ou "google"	Plateforme Wallet
additionalInformation	AdditionalPassInstallationInformation	Inclut les statistiques d'inscription

Exemple d'implémentation

Les scripts peuvent être placés dans le server/scripts dossier dans la configuration avancée.

const API_URL = 'https://partner';
import { getSecret } from 'neo/secrets';

/** 
 * @typedef {Object} RegistrationInformation 
 * @property {number} activeRegistrationCount - Inscriptions actives. 
 * @property {number} totalRegistrationCount - Inscriptions totales. 
 **/ 

/**
 * @typedef {Object} RegistrationSource
 * @property {string[]} tags - liste des balises spécifiées par l'intégration SDK
 * @property {string} medium - support spécifié par l'intégration SDK ou utm_medium
 * @property {string} origin  - URL depuis laquelle la Carte est installée - peut être remplacée par l'intégration SDK
 * @property {string} userAgent - UserAgent facultatif utilisé pour installer la Carte
 */

/** 
 * @typedef {Object} AdditionalPassInstallationInformation
 * @property {RegistrationInformation} registrationInformation - Statistiques d'inscription. 
 * @property {RegistrationSource} registrationSource - Source de l'installation lorsqu'elle est disponible 
 */

/** méthodes déclenchées lorsqu'une Carte est installée 
 * @param {string} passId - identifiant unique de la Carte
 * @param {string} passType - type de Carte de la Carte actuelle
 * @param {Record<string, any>} identifiers - paires clé-valeur d'identifiants de la Carte
 * @param {"apple"|"google"} device - nom de l'appareil
 * @param {AdditionalPassInstallationInformation} additionalInformation - additionalInformation liée à cette installation de Carte */
 async function onPassInstalled(passId, passType, identifiers, device, additionalInformation) {
     await onPassInstallationStatusChanged(passId, passType, identifiers, device, true);
} 

/** méthodes déclenchées lorsqu'une Carte est désinstallée 
 * @param {string} passId - identifiant unique de la Carte 
 * @param {string} passType - type de Carte de la Carte actuelle
 * @param {Record<string, any>} identifiers - paires clé-valeur d'identifiants de la Carte
 * @param {"apple"|"google"} device - nom de l'appareil 
 * @param {AdditionalPassInstallationInformation} additionalInformation - additionalInformation liée à cette installation de Carte 
 */ 
async function onPassUninstalled(passId, passType, identifiers, device, additionalInformation) { 
    await onPassInstallationStatusChanged(passId, passType, identifiers, device, false); 
} 

async function onPassInstallationStatusChanged(passId, passType, identifiers, device, isInstalled) {
  const customerId = identifiers["customerId"]; // ou tout autre identifiant externe
  const API_SECRET = await getSecret('PARTNER-API-SECRET');

  // ⚠️ Remarque : fetch n'est pas standard ici. Il utilise des options en PascalCase et un Body basé sur des objets.
  await fetch(API_URL + '/wallet/installation', {
    Method: "POST",
    Headers: {
      "Content-Type": "application/x-www-form-urlencoded",
      "X-API-KEY": API_SECRET
    },
    Body: {
      customerId,
      isInstalled,
      appareil
    },
    ThrowOnError: false
  });
}

export default function (context) {
  context.register('runtime.wallet.passUpdater', {
    OnPassInstalled: onPassInstalled,
    OnPassUninstalled: onPassUninstalled
  });
}

Exemple minimal

Pour les tests ou la journalisation uniquement :

async function onPassInstalled(passId, passType, identifiers, device) {
  console.log(`Carte ${passId} installée sur ${device}`);
}

async function onPassUninstalled(passId, passType, identifiers, device) {
  console.log(`Carte ${passId} désinstallée de ${device}`);
}

export default function (context) {
  context.register('runtime.wallet.passUpdater', {
    OnPassInstalled: onPassInstalled,
    OnPassUninstalled: onPassUninstalled
  });
}

Quand les événements sont-ils déclenchés ?

• OnPassInstalled → déclenché lorsqu'un client ajoute avec succès une Carte à Apple ou Google Wallet.

• OnPassUninstalled → déclenché lorsqu'un client retire la Carte de son Wallet.

• Les événements sont fiables : la plateforme garantit une remise correcte même en cas de forte charge.

Remarques

• fetch est pas le fetch standard du navigateur — il accepte des options en PascalCase (Method, Headers, Body, ThrowOnError).

• L'authentification est flexible : les clés API (via getSecret) ou OAuth avec le custom fetch sont tous deux pris en charge.

• L'exécution s'effectue dans le même runtime sandboxé que chaque script de connecteur personnalisé : une limite d'exécution de 5 secondes par invocation, un ensemble restreint de bibliothèques approuvées et une validation automatisée avant qu'un script puisse être enregistré. Voir Connecteurs personnalisés → Contraintes d'exécution pour la liste complète de ce qui est disponible dans un script.

FAQ

Ces événements sont-ils en temps réel ?

Ils se déclenchent lorsque la Carte est ajoutée ou retirée du Wallet. En pratique, traitez-les comme quasi temps réel. Concevez l'API réceptrice pour qu'elle soit idempotente, afin que les nouvelles tentatives ne créent pas de doublons.

Que se passe-t-il si l'API externe est en panne ?

Le code du connecteur contrôle l'appel. Gérez les délais d'attente et les erreurs avec élégance. Si le système externe est critique, mettez en place des tentatives de reprise et une stratégie de lettres mortes côté récepteur.

Cela peut-il être utilisé pour déclencher des e-mails ou des campagnes push ?

Oui. Le schéma le plus courant consiste à appeler la plateforme d'automatisation marketing (directement ou via le backend de la marque) et à déclencher un parcours lors de l'installation. Utilisez les événements de désinstallation pour arrêter ou adapter les communications.

Que comprend additionalInformation?

Cela peut inclure des statistiques d'inscription et, lorsqu'elle est disponible, la source de l'installation. Utilisez-la pour mesurer l'adoption et attribuer les installations à une campagne ou à une intégration SDK.