Récupérer des données grâce au contenu connecté

Avec Braze Connected Content, vous pouvez récupérer des données de l’API Voucherify et envoyer des messages à des segments Braze spécifiques. Cet article de référence vous montrera comment mettre en place des scripts de contenu connecté pour publier des coupons Voucherify, inviter de nouvelles recommandations, récupérer le solde des cartes de fidélité, et plus encore.

Cette intégration est gérée par Voucherify.

À propos de l’intégration

Le schéma de base du script est le suivant :

1
2
3
4
5
6
7
8
9
10
11
{% connected content
  "voucherify-API-ENDPOINT-url"
  :method post
  :headers {
    "X-App-Id": "Voucherify-API-key",
    "X-App-Token": "Voucherify-Secret-key",
  }
  :content_type application/json
  :retry
  :save {{result_variable}}
}

Visitez le dépôt GitHub de Voucherify pour voir des exemples de scripts de contenu connecté.

Paramètres de sécurité

Si les paramètres suivants ne sont pas définis chaque fois qu’un message de contenu connecté est déclenché, l’API Voucherify sera appelée au moins deux fois. Ces paramètres réduisent le nombre d’appels à l’API facturés à Braze et diminuent le risque d’atteindre la limite de blocage de l’API, ce qui pourrait interrompre la distribution des messages.

• limite de débit
• mise en cache
• attribut retry
• publications uniques
• rejoindre une fois

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{% assign braze_campaign_id = {{campaign.${api_id}}} %}
{% assign customer_id = {{${user_id}}} %}
{% assign cache_id = braze_campaign_id | append: customer_id %}
{% assign voucherify_campaign_id = "VOUCHERIFY-CAMPAIGN_ID" %}

{% connected_content
   https://api.voucherify.io/v1/publications?cache_id={{cache_id}}
   :method post
   :headers {
    "X-App-Id": "VOUCHERIFY-APP-ID",
    "X-App-Token": "VOUCHERIFY-APP-TOKEN"
   }
   :body campaign={{voucherify_campaign_id}}&customer={{customer_id}}&channel=Braze
   :content_type application/json
   :cache_max_age
   :retry
   :save publication
 %}

Cas d’utilisation

Gardez à l’esprit que tous les cas d’utilisation ci-dessous utilisent l’ID de la source de publication Voucherify et les paramètres de cache et de relance de Braze pour limiter les appels API invoqués par une campagne Braze. Vous devez être conscient des conséquences suivantes :

• Il n’est pas possible de publier et d’envoyer différents codes au même client dans une seule campagne Braze.
• Si votre campagne Voucherify utilise la fonctionnalité “join only once, vous devez supprimer source_id du corps du contenu connecté comme décrit dans l’onglet “join-once” ci-dessus.

Visitez le dépôt GitHub de Voucherify pour voir des exemples de scripts de contenu connecté.

Publier et envoyer un code de coupon unique

Dans ce cas d’utilisation, le script de contenu connecté appelle l’API Voucherify pour publier un code de coupon unique et l’envoyer dans le message Braze. Chaque utilisateur de Braze reçoit un code unique.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{% assign braze_campaign_id = {{campaign.${api_id}}} %}
{% assign customer_id = {{${user_id}}} %}
{% assign source_id = braze_campaign_id | append: customer_id %}
{% assign voucherify_campaign_id = "VOUCHERIFY-CAMPAIGN_ID" %}
{% assign cache_id = source_id %}

{% connected_content
   YOUR API ENDPOINT/v1/publications?cache_id={{cache_id}}
   :method post
   :headers {
        "X-App-Id": "VOUCHERIFY-APP-ID",
        "X-App-Token": "VOUCHERIFY-APP-TOKEN"
   }
   :body campaign={{voucherify_campaign_id}}&customer={{customer_id}}&channel=Braze&source_id={{source_id}}
   :content_type application/json
   :cache_max_age
   :retry
   :save publication
 %}

Inviter de nouveaux référents

Si vous souhaitez qu’un client adhère à un programme de recommandation, vous devez lui attribuer un code de recommandation. Le contenu connecté reste le même que dans l’exemple précédent. Ce script de contenu connecté vous permet de publier et d’envoyer des codes de recommandation uniques à des utilisateurs sélectionnés de Braze. Chaque utilisateur reçoit un seul code de recommandation qu’il peut partager avec d’autres utilisateurs et obtenir de nouvelles recommandations.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{% assign braze_campaign_id = {{campaign.${api_id}}} %}
{% assign customer_id = {{${user_id}}} %}
{% assign source_id = braze_campaign_id | append: customer_id %}
{% assign voucherify_campaign_id = "VOUCHERIFY-CAMPAIGN_ID" %}
{% assign cache_id = source_id %}

{% connected_content
   YOUR API ENDPOINT/v1/publications?cache_id={{cache_id}}
   :method post
   :headers {
        "X-App-Id": "VOUCHERIFY-APP-ID",
        "X-App-Token": "VOUCHERIFY-APP-TOKEN"
   }
   :body campaign={{voucherify_campaign_id}}&customer={{customer_id}}&channel=Braze&source_id={{source_id}}
   :content_type application/json
   :cache_max_age
   :retry
   :save publication
 %}

Consulter le solde de la carte de fidélité

Voici un cas d’utilisation d’un script de contenu connecté qui tire le solde de fidélité actuel en fonction du code de la carte de fidélité qui a été envoyé au préalable à Braze en tant qu’attribut personnalisé. Notez que vous devez enregistrer le code de la carte de fidélité en tant qu’attribut personnalisé dans le profil utilisateur de Braze avant d’utiliser ce script.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{% assign braze_campaign_id = {{campaign.${api_id}}} %}
{% assign customer_id = {{${user_id}}} %}
{% assign source_id = braze_campaign_id | append: customer_id %}
{% assign voucherify_campaign_id = "VOUCHERIFY-CAMPAIGN_ID" %}
{% assign cache_id = source_id %}

{% connected_content
   YOUR API ENDPOINT/v1/loyalties/members/{{custom_attribute.${loyalty.card}}}?cache_id={{cache_id}}
   :method get
   :headers {
        "X-App-Id": "VOUCHERIFY-APP-ID",
        "X-App-Token": "VOUCHERIFY-APP-TOKEN"
   }
   :content_type application/json
   :cache_max_age
   :retry
   :save member
 %}

Créer un code personnalisé

Le contenu connecté est un outil puissant permettant d’introduire des scénarios créatifs. Vous pouvez créer un code de coupon personnalisé sur la base des informations du profil du client.

Voici un extrait de code qui prendra en compte le numéro de téléphone du client pour générer un code unique. Dans ce cas d’utilisation, le script de contenu connecté appelle l’API Voucherify pour publier un code de coupon personnalisé.

1. Définissez d’abord toutes les variables nécessaires. Créez ensuite un code de réduction commençant par le préfixe “REST”, le reste du code étant le numéro de téléphone du client. Vous pouvez décider de l’attribut personnalisé sur lequel vous souhaitez baser vos codes de coupon.

   1
   2
   3
   4
   5
   6
   7
   {% assign braze_campaign_id = {{campaign.${dispatch_id}}} %}
   {% assign customer_id = {{${user_id}}} %}
   {% assign phoneNumber = {{${phone_number}}} %}
   {% assign source_id = braze_campaign_id | append: customer_id %}
   {% assign cache_id = source_id %}
   {% assign voucherify_campaign_id = "VOUCHERIFY-CAMPAIGN_ID" %}
   {% assign prefix = "SummerTime-" %}
   

2. Ensuite, demandez à Voucherify de générer un seul code dans la campagne. Nous indiquons le nom du code de coupon à créer dans l’URL :

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   {% connected_content
      YOUR-API-ENDPOINT/v1/campaigns/{{voucherify_campaign_id}}/vouchers/{{prefix}}{{phoneNumber}}?cache_id={{cache_id}}
      :method post
      :headers {
           "X-App-Id": "VOUCHERIFY-APP-ID",
           "X-App-Token": "VOUCHERIFY-APP-TOKEN"
      }
      :content_type application/json
      :cache_max_age 
      :save voucher_created
      :retry
   %}  
   

3. Enfin, publiez le code que vous venez de créer. L’extrait de code est presque le même que celui que vous avez utilisé pour générer un bon aléatoire à partir d’une campagne. Toutefois, cette fois-ci, nous ciblons un code de bon spécifique.

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   {% connected_content
      YOUR-API-ENDPOINT/v1/publications?cache_id={{cache_id}}
      :method post
      :headers {
          "X-App-Id": "VOUCHERIFY-APP-ID",
          "X-App-Token": "VOUCHERIFY-APP-TOKEN"
      }
      :body voucher={{prefix}}{{phoneNumber}}&customer={{customer_id}}&channel=Braze&source_id={{source_id}}
      :content_type application/json
      :cache_max_age 
      :save publication
      :retry
   %}
   

En conséquence, le client reçoit l’e-mail suivant :

Voici l’extrait de code complet utilisé dans cet exemple :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
{% assign braze_campaign_id = {{campaign.${dispatch_id}}} %}
{% assign customer_id = {{${user_id}}} %}
{% assign phoneNumber = {{${phone_number}}} %}
{% assign source_id = braze_campaign_id | append: customer_id %}
{% assign cache_id = source_id %}
{% assign voucherify_campaign_id = "VOUCHERIFY-CAMPAIGN_ID" %}
{% assign prefix = "Your Prefix" %}

{% connected_content
   YOUR-API-ENDPOINT/v1/campaigns/{{voucherify_campaign_id}}/vouchers/{{prefix}}{{phoneNumber}}?cache_id={{cache_id}}
   :method post
   :headers {
        "X-App-Id": "VOUCHERIFY-APP-ID",
        "X-App-Token": "VOUCHERIFY-APP-TOKEN"
   }
   :content_type application/json
   :cache_max_age 
   :save voucher_created
   :retry
%} 

{% connected_content
   YOUR-API-ENDPOINT/v1/publications?cache_id={{cache_id}}
   :method post
   :headers {
       "X-App-Id": "VOUCHERIFY-APP-ID",
       "X-App-Token": "VOUCHERIFY-APP-TOKEN"
   }
   :body voucher={{prefix}}{{phoneNumber}}&customer={{customer_id}}&channel=Braze&source_id={{source_id}}
   :content_type application/json
   :cache_max_age 
   :save publication
   :retry
%}

Afficher les données récupérées dans les messages de Braze

Nous supposons que vous disposez déjà d’une campagne Braze ou d’un Canvas dans lequel vous souhaitez utiliser le script Contenu connecté.

Étape 1 : Ajouter un script de contenu connecté au modèle de message

1. Copiez et collez le script de contenu connecté sous l’étiquette <body> dans un modèle de message HTML. Remplacez CAMPAIGN_ID par une adresse campaign_id copiée à partir de l’adresse URL du tableau de bord de la campagne Voucherify.
   

   1
   assign voucherify_campaign_id = "camp_Y7h1meBSyybsNs7UpSVVZZce"
   

2. Indiquez votre endpoint API Voucherify. Si vous ne connaissez pas votre endpoint API, vous pouvez le vérifier dans les paramètres du projet > Général > Endpoint API.
   

   1
    YOUR API ENDPOINT/v1/publications?cache_id={{cache_id}}
   

   Cluster partagé	Endpoint pour le contenu connecté de Braze
   Europe (par défaut)	https://api.voucherify.io/v1/publications
   États-Unis	https://us1.api.voucherify.io/v1/publications
   Asie (Singapour)	https://as1.api.voucherify.io/v1/publications

3. Ajoutez vos clés API pour l’authentification. Vous trouverez Voucherify-App-Id et Voucherify-App-Token dans les paramètres de votre projet > Général > Clés d’application.
   

   1
   2
   "X-App-Id": "VOUCHERIFY-APP-ID",
   "X-App-Token": "VOUCHERIFY-APP-TOKEN"
   

Votre script de contenu connecté est maintenant prêt à fonctionner.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{% assign braze_campaign_id = {{campaign.${api_id}}} %}
{% assign customer_id = {{${user_id}}} %}
{% assign source_id = braze_campaign_id | append: customer_id %}
{% assign voucherify_campaign_id = "camp_Y7h1meBSyybsNs7UpSVVZZce" %}
{% assign cache_id = source_id %}

{% connected_content
   https://api.voucherify.io/v1/publications?cache_id={{cache_id}}
   :method post
   :headers {
        "X-App-Id": "490a3fb6-a",
        "X-App-Token": "328099d5-a"
   }
   :body campaign={{voucherify_campaign_id}}&customer={{customer_id}}&channel=Braze&source_id={{source_id}}
   :content_type application/json
   :cache_max_age
   :retry
   :save publication
 %}

Étape 2 : Créez un extrait de code pour afficher les données récupérées.

Les réponses de l’API Voucherify sont stockées par le contenu connecté sous la valeur du paramètre :save. Par exemple :

1
:save member

Cela vous permet de récupérer et d’afficher les données d’une réponse Voucherify dans des messages Braze.

Vous pouvez créer des extraits qui affichent le code publié, le solde de la carte de fidélité, la date d’expiration et d’autres paramètres inclus dans la réponse au format JSON de l’API Voucherify.

Par exemple, pour afficher le code publié dans un modèle de message, vous devez créer un extrait qui récupère un code unique dans l’objet du bon.

Script de contenu connecté :

Extrait de code dans le modèle de message de Braze :

1
{{publication.voucher.code}}

Ainsi, chaque client reçoit un message avec un code unique automatiquement attribué à son profil. Chaque fois qu’un code est reçu par l’utilisateur, il est publié sur son profil dans Voucherify.

Pour afficher le solde d’une carte de fidélité récupéré depuis l’API de Voucherify, vous devez créer l’extrait de code suivant :

1
{{member.loyalty_card.balance}}

où le membre est une valeur du paramètre :save dans le script de contenu connecté.

1
:save member

Nous vous conseillons vivement de ne pas dépendre entièrement du “mode aperçu” et d’envoyer plusieurs messages de test pour confirmer que tout fonctionne comme il se doit.

Étape 3 : Configuration d’une limite de débit

Lors de la définition d’une cible de campagne, utilisez les paramètres avancés pour limiter le nombre de messages envoyés par minute.

Pour en savoir plus sur le limiteur de débit et la limite de fréquence, consultez la documentation Braze.