Déclencher des campagnes à l’aide d’API trigger-campaigns
À propos des campagnes déclenchées par API about
Avec Journey Optimizer, vous pouvez créer des campagnes, puis les exécuter à partir d’un système externe basé sur un déclencheur utilisateur à l’aide de l’ API REST pour l’exécution des messages interactifs. Vous pouvez ainsi couvrir divers besoins de messagerie marketing et transactionnelle tels que les réinitialisations de mot de passe, le jeton OTP, etc.
Pour cela, vous devez d’abord créer une campagne déclenchée par une API dans Journey Optimizer, puis lancer son exécution via un appel API.
Les canaux disponibles pour les campagnes déclenchées par API sont E-mail, SMS et les messages push.
➡️ Découvrez cette fonctionnalité en vidéo.
Créer une campagne déclenchée par API create
Configurer et activer la campagne create-activate
Pour créer une campagne déclenchée par API, suivez les étapes ci-dessous. Vous trouverez des informations détaillées sur la création d’une campagne dans cette section.
-
Créez une campagne avec le type déclenché par API.
-
Choisissez la catégorie Marketing ou Transactionnelle selon le type de communication que vous souhaitez envoyer.
-
Sélectionnez l’un des canaux pris en charge et la configuration de canal associée à utiliser pour envoyer votre message, puis cliquez sur Créer.
-
Indiquez un titre et une description pour la campagne, puis cliquez sur Modifier le contenu pour configurer le message à envoyer.
note note NOTE Vous pouvez transmettre des données supplémentaires dans la payload de l’API que vous pouvez utiliser pour personnaliser votre message. En savoir plus L’utilisation d’un grand nombre de données contextuelles importantes dans votre contenu peut avoir un impact sur les performances. -
Dans la section Audience, spécifiez l’espace de noms à utiliser pour identifier les personnes.
-
Si vous créez une campagne transactionnelle, les profils ciblés doivent être définis dans l’appel API. L’option Créer de nouveaux profils permet de créer automatiquement des profils qui n’existent pas dans la base de données. En savoir plus sur la création de profils lors de l’exécution de la campagne
note note NOTE Un seul appel API prend en charge jusqu’à 20 personnes destinataires uniques. Chacune de ces personnes doit disposer d’un identifiant d’utilisateur ou d’utilisatrice unique, les doublons n’étant pas autorisés. Pour en savoir plus, consultez la documentation de l’API d’exécution de message interactif -
Pour les campagnes marketing, cliquez sur le bouton Audience pour sélectionner l’audience à cibler.
-
-
Configurez les dates de début et de fin de la campagne.
Si vous configurez une date de début et/ou de fin spécifique pour une campagne, elle ne sera pas exécutée en dehors de ces dates et les appels API échoueront si la campagne est déclenchée par des API.
-
Cliquez sur Examiner pour activer pour vérifier que votre campagne est correctement paramétrée, puis activez-la.
Vous pouvez maintenant exécuter la campagne à partir des API. En savoir plus.
Exécuter la campagne execute
Une fois votre campagne activée, vous devez récupérer l’exemple de requête cURL généré et l’utiliser dans l’API pour créer votre payload et déclencher la campagne.
-
Ouvrez la campagne, puis copiez-collez la requête de payload depuis la section requête cURL. Cette payload inclut toutes les variables de personnalisation (profil et contexte) utilisées dans le message. Elle est disponible une fois la campagne activée.
-
Utilisez cette requête cURL dans les API pour créer votre payload et déclencher la campagne. Pour plus d’informations, consultez la documentation de l’API d’exécution de message interactif.
Des exemples d’appels API sont également disponibles sur cette page.
note note NOTE Si vous avez configuré une date de début et/ou de fin spécifique lors de la création de la campagne, elle ne sera pas exécutée en dehors de ces dates et les appels API échoueront.
Utilisation d’attributs contextuels dans des campagnes déclenchées par API contextual
Avec les campagnes déclenchées par API, vous pouvez transmettre des données supplémentaires dans la payload de l’API et les utiliser dans la campagne pour personnaliser votre message.
Prenons un exemple où les clients souhaitent réinitialiser leur mot de passe et où vous souhaitez leur envoyer une URL de réinitialisation de mot de passe générée dans un outil tiers. Avec les campagnes déclenchées par API, vous pouvez transmettre cette URL générée dans la payload de l’API et l’utiliser dans la campagne pour l’ajouter au message.
Pour utiliser ces données dans vos campagnes, vous devez les passer dans le payload de l’API et les ajouter dans votre message à l’aide de l’éditeur de personnalisation. Pour ce faire, utilisez la syntaxe {{context.<contextualAttribute>}}, où <contextualAttribute> doit correspondre au nom de la variable dans votre payload de l’API contenant les données que vous souhaitez transmettre.
La syntaxe {{context.<contextualAttribute>}} est mappée à un type de données String uniquement.
context.system est limitée à l’utilisation interne d’Adobe uniquement et ne doit pas être utilisée pour transmettre des attributs contextuels.Notez que, pour l’instant, aucun attribut contextuel n’est disponible dans le menu du rail de gauche. Les attributs doivent être saisis directement dans votre expression de personnalisation, sans vérification effectuée par Journey Optimizer.
Création de profils lors de l’exécution de la campagne profile-creation
Dans certains cas, vous devrez peut-être envoyer des messages transactionnels à des profils qui n’existent pas dans le système, par exemple si une personne inconnue tente de réinitialiser un mot de passe sur votre site web.
Lorsqu’un profil n’existe pas dans la base de données, Journey Optimizer vous permet de le créer automatiquement lors de l’exécution de la campagne afin de permettre l’envoi du message à ce profil.
Pour activer la création de profil lors de l’exécution de la campagne, activez l’option Créer de nouveaux profils dans la section Audience. Si cette option est désactivée, les profils inconnus sont refusés pour tout envoi et l’appel API échoue.
Vidéo pratique video
Découvrez comment créer une campagne et la déclencher à partir d’un système externe en fonction des interactions des utilisateurs et utilisatrices, à l’aide de l’API REST d’exécution de message interactif.