Passer au contenu

Entrée basée sur l'API

Comment ça marche

Anchor link to

L’entrée basée sur l’API vous permet de lancer un parcours client au moment même où un événement métier spécifique se produit. Pour démarrer une campagne, vous devez envoyer une requête API spéciale.

Voici quelques cas d’utilisation pour une entrée basée sur l’API :

  • Informer les clients lorsque les produits sont de retour en stock
  • Informer les utilisateurs que le prix d’un produit populaire a baissé
  • Avertir les abonnés de la sortie d’un nouvel épisode de podcast

Contrairement aux Événements classiques, tous ces événements métier peuvent se produire en dehors de l’application. Par exemple, la disponibilité d’un produit ne peut être vérifiée que dans une base de données externe. C’est là que l’entrée basée sur l’API est utile : vous pouvez configurer l’envoi d’une requête pour lancer un parcours chaque fois que certaines modifications se produisent en dehors de l’application (par exemple, dans votre base de données externe).

Élément d'entrée basé sur l'API sur le canevas du parcours

Cela fonctionne comme suit :

  1. Créez un parcours avec une entrée basée sur l’API. Dans les paramètres d’entrée, vous trouverez le modèle de la requête qui lance le parcours.
  2. Ajoutez des conditions de segmentation à la requête en utilisant le langage de segmentation. Vous pouvez également ajouter des placeholders de contenu à la requête pour modifier le contenu du message en fonction du contexte.
  3. Automatisez la requête si nécessaire. Par exemple, les informations sur un changement de prix peuvent être immédiatement envoyées de la base de données au webhook. Une fois que cela se produit, le webhook doit automatiquement envoyer la requête pour lancer le parcours. Vous pouvez également envoyer la requête manuellement si vous n’avez pas besoin d’automatisation.

Vous pouvez envoyer la requête un nombre illimité de fois pour modifier les conditions de segmentation ou le contenu du message.

Pour plus de détails, suivez les instructions ci-dessous.

Configurer un parcours avec une entrée basée sur l’API

Anchor link to
  1. Créez un parcours avec une entrée basée sur l’API :
  1. Double-cliquez sur l’étape d’entrée basée sur l’API. La fenêtre de configuration de l’entrée s’ouvrira.

  2. Vous pouvez modifier le contenu des notifications push et des e-mails chaque fois que le parcours est lancé en utilisant des placeholders de contenu. La valeur de chaque placeholder peut être modifiée dans la requête. Si vous n’avez pas besoin de cette option, vous pouvez ignorer cette étape.

Par exemple, vous créez un parcours pour avertir les abonnés de la sortie d’un nouvel épisode de podcast. En utilisant un placeholder de contenu, vous pouvez changer le titre du podcast chaque fois que vous lancez le parcours.

Tout d’abord, ajoutez des noms de placeholders dans la fenêtre de configuration de l’entrée basée sur l’API. Vous pouvez utiliser les noms qui vous conviennent.

Ajouter des noms de placeholders de contenu dans la fenêtre de configuration de l'entrée basée sur l'API

Maintenant, créez un préréglage push ou un contenu d’e-mail et insérez le placeholder à la place du texte que vous souhaitez modifier. Le placeholder doit être dans l’un des formats suivants en fonction de vos besoins :

  • {placeholder_name|format_modifier|} – si la valeur du placeholder n’est pas spécifiée lors du lancement de la campagne, les utilisateurs verront un espace vide à sa place.
  • {placeholder_name|format_modifier} – si la valeur du placeholder n’est pas spécifiée et n’a pas déjà été attribuée à un utilisateur (au cas où vous auriez utilisé un Tag comme placeholder), le message ne sera pas envoyé.
Modificateurs de format
  • CapitalizeFirst – met en majuscule la première lettre de la valeur d’un placeholder
  • CapitalizeAllFirst – met en majuscule la première lettre de tous les mots de la valeur d’un placeholder
  • UPPERCASE – met toutes les lettres en majuscules
  • lowercase – met toutes les lettres en minuscules
  • regular – insère la valeur d’un placeholder exactement comme spécifié dans la requête
Insérer un placeholder dans un préréglage push pour du contenu dynamique

Lors de la configuration de l’élément Push ou E-mail dans votre parcours, sélectionnez le préréglage créé et activez l’option Personnaliser le message avec les attributs d’événement.

Sélectionnez les placeholders que vous souhaitez modifier dans la requête lors du lancement du parcours. Choisissez l’entrée Entrée basée sur l’API comme source et le nom du placeholder comme attribut dynamique :

Cliquez sur Appliquer pour enregistrer les modifications.

  1. Dans la fenêtre de configuration de l’entrée, copiez le modèle de requête pour le modifier :
Copier le modèle de requête depuis la fenêtre de configuration de l'entrée basée sur l'API
  1. Ajoutez des filtres d’audience au paramètre "filter" en utilisant le langage de segmentation ou copiez la logique de segmentation depuis vos segments. Configurez les Tags nécessaires à l’avance.

Par exemple, pour cibler les utilisateurs qui ont ajouté l’article Socks à leur Wishlist, la valeur de "filter" doit ressembler à ce qui suit :

"filter": "A(\"12345-12345\") * "T(\"Wishlist\", EQ, \"Socks\")"

Dans cet exemple, vous devez avoir un Tag Wishlist configuré dans votre application.

  1. Si vous avez configuré des placeholders, spécifiez le contenu souhaité comme leurs valeurs :
Spécifier les valeurs des placeholders dans la requête API pour lancer le parcours
  1. Si vous prévoyez de redémarrer votre campagne fréquemment et que vous ne voulez pas que les mêmes utilisateurs entrent plusieurs fois dans le parcours, définissez des limites d’entrée dans la campagne.

Par exemple, vous avez créé une campagne pour informer les utilisateurs d’une réduction de prix sur un produit spécifique. Vous souhaitez relancer le parcours plusieurs fois en envoyant plusieurs requêtes avec différents filtres d’audience. Dans ce cas, vous pouvez ajouter des limites d’entrée dans la campagne afin que la notification ne soit pas envoyée à plusieurs reprises aux utilisateurs qui correspondent à plusieurs filtres.

  1. Si vous souhaitez qu’un parcours se lance chaque fois qu’un certain événement métier se produit, automatisez la requête à l’aide du webhook. Une fois l’événement survenu, le webhook doit envoyer automatiquement la requête pour démarrer le parcours.

Vous pouvez également envoyer la requête manuellement si vous n’avez pas besoin d’automatisation.