Dans cet article, vous trouverez quelques exemples sur la manière d'utiliser notre API. Pour en savoir plus sur la façon d'utiliser l'API, consultez la vue d'ensemble.
L'API dans son intégralité et les méthodes mentionnées ci-dessous se trouvent sur https://<server>.carmamail.com/mail/swagger
Remplacez <server> par le numéro de serveur de votre compte Symplify. Vous le trouverez en bas du menu principal lorsque vous serez connecté.
Cliquez sur les exemples de méthodes pour obtenir des informations plus détaillées, mais veuillez noter que tous les liens vers l'API ci-dessous sont dirigés vers le serveur "www". Mettez à jour le numéro de votre serveur avant de commencer les tests.
Un petit truc rapide cependant, l'Original ID est la clé qui vous permet d'échanger des données pour un destinataire spécifique.
EXEMPLES
Disons que nous avons une boutique en ligne. Dans notre boutique en ligne, nous vendons de la nourriture. Nous avons une infolettre dans laquelle nous proposons différents contenus en fonction des goûts du destinataire.
Nous utilisons Symplify pour toutes nos communications avec nos clients.
1. Processus d'inscription
Nous voulons mettre en place une simple inscription à l'infolettre hébergée sur notre site et voulons que les nouveaux destinataires soient enregistrés dans notre base de données dans Symplify. Pour faire simple, le client ne saisira que son adresse e-mail.
Après avoir créé le formulaire sur notre site, nous devons établir la connexion à Symplify avec l'API.
Tout d'abord, il est bon de vérifier si le client existe déjà dans notre base de données, afin de ne pas avoir de doublons.
Nous utilisons la méthode REST ci-dessous pour vérifier si le client existe déjà dans notre base de données Symplify :
GET /{customerid}/lists/{id}/contacts/{originalId}
Si le client n'existe pas, nous utilisons la méthode suivante pour créer notre nouveau destinataire :
POST /{customerid}/lists/{id}/contacts
2. Confirmation de la commande
Nous voulons mettre en place un courriel de confirmation de commande afin que nos clients reçoivent un message lorsqu'ils ont passé une commande.
La première étape consiste à créer le véritable courriel de confirmation de la commande dans Symplify. Ceci est exécuté dans Journeys avec un déclencheur de requête API. Le déclencheur fournira les informations sur la façon de se rendre sur place.
POST /{customerid}/journeys/{id}/commence
Maintenant que nous pouvons envoyer un courriel de confirmation de l'achat, il serait intéressant de donner au client un résumé de son achat. Nous pouvons effectuer cela de différentes manières.
Nous pouvons utiliser les handlebars dans le courriel de confirmation pour présenter les lignes de commandes (en ayant accès à l'historique d'achat). Si nous voulons une mise en page mieux conçue pour ces données, nous pouvons contacter notre Success Manager sur Symplify et obtenir un courriel de confirmation personnalisé.
3. Mettre à jour les données des destinataires
Bien entendu, nous voulons envoyer un contenu pertinent à nos destinataires et pour ce faire, nous voulons connaître leurs goûts et leurs centres d'intérêt. C'est pourquoi nous incluons dans nos envois un lien vers une page de profil. Nous utilisons ensuite les données recueillies pour créer des segments dans Symplify afin de cibler des sujets spécifiques à des destinataires spécifiques.
Dans ce cas, nous hébergerons le formulaire nous-mêmes, donc nous créons d'abord la page de profil sur notre site, puis nous créons les attributs du destinataire dans Symplify en répondant aux choix de la page de profil. Nos destinataires peuvent choisir les goûts aigre et/ou doux. Ainsi, dans Symplify, nous créons les attributs.
aigre (id 100)
doux (id 101)
Ensuite, il est temps de connecter la page de profil à notre base de données Symplify.
Nous utilisons la méthode
PUT /{customerid}/lists/{id}/contacts/{originalId}
Pour mettre à jour les attributs, nous pouvons soit utiliser le nom de l'attribut OU l'identifiant de l'attribut et envoyer les données à Symplify dans les "properties" :
“properties”: {”sour”:”yes”, ”sweet”:”no”}
OU
”properties”: {”100”:”yes”, ”101”:”no”}
4. Hébergement de la page de désabonnement
Nous voulons gérer les désabonnements dans la page de profil de notre côté, c'est pourquoi nous créons la page de désabonnement et la page de confirmation sur notre site.
Nous marquons le lien vers la page d'opt out avec une chaîne d'identification unique cryptée {{message.guid}}{{message.id}}.
Exemple: http://www.example.com/optoutpage.html?id={{message.guid}}{{message.id}}
Nous ajoutons ensuite le lien ci-dessus dans nos courriels Symplify et lorsque le destinataire clique sur le bouton de désabonnement, il sera redirigé vers notre page de profil de désabonnement.
Notre landing page/page optout devrait utiliser les méthodes REST suivantes pour identifier le destinataire et également mettre à jour son statut (si le destinataire choisit de le faire après avoir atteint la page optout).
Pour obtenir l'adresse électronique du destinataire (avec d'autres attributs si vous le souhaitez) :
GET /{customerid}/lists/contacts?muid={{message.guid}}{{message.id}}
Pour modifier le statut actuel d'abonnement du destinataire :
PUT /{customerid}/lists/{id}/contacts/{originalId}/subscriptionstatus
Résumé
Ainsi, avec cette configuration, nous avons une inscription, une page de profil (où nos clients peuvent choisir des préférences de contenu ou se désabonner) et nous avons une confirmation de commande.
AUTRES EXEMPLES
5. Si vous souhaitez vérifier si un destinataire figure plus d'une fois sur une liste de destinataires
Lorsque le destinataire entre sur la landing page/page de profil, vous pouvez également vérifier si le destinataire apparaît plus d'une fois avec la méthode ci-dessous :
GET /{customerid}/lists/{id}/contacts
6. Si vous souhaitez que les destinataires puissent se réabonner à une liste à laquelle ils se sont désabonnés
PUT /{customerid}/lists/{id}/contacts/{originalId}/subscriptionstatus
Schéma modèle pour le statut de l'abonnement :
SubscriptionStatusDto {
status (SubscriptionStatus) = [‘SUBSCRIBED’ or ‘UNSUBSCRIBED’]: subcsriptionstatus for email,
mobileStatus (MobileSubscriptionStatus) = [‘SUBSCRIBED’ or ‘UNSUBSCRIBED’]: subcsriptionstatus for mobile
}