circle-exclamation
This documentation is currently under development. Certain sections are not yet complete and will be added shortly.

Adobe campaign

Mettez à jour les cartes The Wallet Crew depuis des workflows Adobe Campaign Classic en appelant l’API The Wallet Crew.

Adobe Campaign (Classic)

Les workflows Adobe Campaign peuvent déclencher des appels API de The Wallet Crew. Cela permet des mises à jour automatisées des cartes pendant une campagne. Les mises à jour typiques incluent l'ajout d'une offre, la mise à jour des données de fidélité ou l'écriture d'un message de campagne dans additionalData.

chevron-rightExemples concretshashtag
  • Une marque de vente au détail ajoute un message personnalisé à la carte d'un segment VIP, juste après l'envoi.

  • Un organisateur de spectacle met à jour un billet Wallet avec un changement de porte de dernière minute.

  • Un fournisseur de billetterie écrit un campaignId dans additionalData pour mesurer les conversions Wallet.

Prérequis

Un accès à une clé API avec l'autorisation de mettre à jour les cartes est requis. Un identifiant stable doit également exister dans Adobe Campaign et correspondre à l'identifiant utilisé pour trouver les cartes dans The Wallet Crew (par exemple, un identifiant client).

circle-info

L'hôte et le chemin de l'API dépendent de l'environnement (QA vs production) et de la configuration du projet The Wallet Crew. Les valeurs d'URL d'exemple doivent être remplacées par celles fournies par The Wallet Crew.

Aperçu de la requête API

L'API de mise à jour des cartes de The Wallet Crew est appelée avec PATCH. L'exemple ci-dessous filtre les cartes en utilisant un identifiant spécifique au projet (id.y2.customerId) et met à jour additionalData.

Exemple de requête PATCH
curl -X 'PATCH' \
  'https://app-qa.neostore.cloud/api/xxxxx/passes?id.y2.customerId=00100000207298' \
  -H 'accept: */*' \
  -H 'X-API-KEY: xyz' \
  -H 'Content-Type: application/json' \
  -d '{
        "additionalData": {
          "adobe_message": "Offre exclusive : venez nous rendre visite."
        }
      }'

Conception du workflow Adobe Campaign

La configuration la plus sûre sépare la sélection et l'exécution. La sélection définit qui doit être mise à jour. L'exécution définit quoi doit être écrit sur la carte.

1

Sélectionner l'audience

Une activité de requête sélectionne la population cible. La transition sortante doit contenir l'identifiant qui correspond à la clé de recherche des cartes The Wallet Crew (exemple : customerId).

2

Itérer sur les enregistrements

Un schéma de workflow peut traiter un enregistrement à la fois, ou de petits lots, selon le volume attendu. Cela réduit le rayon d'impact en cas d'erreurs API.

3

Appeler l'API The Wallet Crew

La PATCH /passes le point de terminaison est appelé pour chaque identifiant. La charge utile doit rester minimale et n'écrire que les champs qui doivent changer (exemple : additionalData.adobe_message).

4

Consigner et gérer les erreurs

Les logs de workflow doivent stocker le code de statut HTTP et le corps de la réponse. Un chemin d'erreur explicite pour les réponses non 2xx est recommandé (re-tentative, mise en quarantaine ou revue manuelle), selon la criticité de la campagne.

5

Valider les résultats

La validation commence généralement par un petit segment de test. Les champs attendus peuvent ensuite être confirmés sur un échantillon de cartes dans The Wallet Crew.

Exemple d'implémentation (activité JavaScript)

Cette section fournit un exemple pour une activité JavaScript Adobe Campaign Classic qui met à jour les cartes dans The Wallet Crew pour une population sélectionnée.

circle-exclamation

Bonnes pratiques

Les tests dans un environnement non production réduisent le risque. La gestion des erreurs doit être explicite, car les échecs d'API peuvent être transitoires. Si la limitation de taux est activée sur le projet, le contrôle du débit ou le traitement par lots aide à éviter les réponses 429. Les clés API doivent être traitées comme des secrets et stockées en utilisant les options sécurisées d'Adobe Campaign, lorsque disponibles.

FAQ

chevron-rightQue doit-on utiliser comme identifiant dans le filtre API ?hashtag

L'identifiant doit correspondre à ce qui a été configuré dans le projet The Wallet Crew pour la recherche de cartes. Les identifiants courants incluent un identifiant client, un identifiant de fidélité ou un identifiant utilisateur externe. Le nom du paramètre de requête (exemple : id.y2.customerId) dépend du modèle de données du projet.

chevron-rightComment confirmer que les cartes ont été mises à jour avec succès ?hashtag

La confirmation nécessite généralement à la fois les logs du workflow et des vérifications ponctuelles dans The Wallet Crew. Les logs du workflow doivent conserver l'identifiant de la requête et la réponse HTTP. Les vérifications ponctuelles doivent confirmer les champs attendus (exemple : additionalData) sur un petit échantillon de cartes.

chevron-rightComment éviter les limites de taux lors de la mise à jour de grandes audiences ?hashtag

Le traitement par lots et le contrôle du débit réduisent les risques d'atteindre les limites de l'API. Une approche courante consiste à traiter les enregistrements par petits groupes, à ajouter des pauses entre les lots et à réessayer avec backoff sur les réponses 429/5xx.

chevron-rightOù la clé API doit-elle être stockée dans Adobe Campaign ?hashtag

Les clés API doivent être traitées comme des secrets. Privilégiez les mécanismes d'Adobe Campaign destinés au stockage des identifiants, plutôt que d'encodage en dur des valeurs dans des activités ou scripts. L'accès doit être restreint au minimum d'opérateurs et de workflows.

Mis à jour