Aller au contenu principal

Webservices liés aux e-mails

La notion de campagne e-mail définit une communication e-mail, personnalisée ou non, envoyée vers une sélection de profils.

Il existe deux types de campagnes :

  • Les campagnes ponctuelle (de masse) : la campagne est envoyée en une seule fois sur toute la cible

  • Les campagnes continues : la campagne est activée pour permettre l'envoi individuel au cours du temps (notamment via un scénario, mais aussi en passant entièrement par API)

Les appels APIs mis à votre disposition en relation avec les e-mails vous permettent de :

Créer une campagne e-mail​

Il est possible de créer une campagne e-mail de masse dans son entièreté par le biais des webservices Actito. Pour ce faire, il sera nécessaire de réaliser plusieurs appels successifs pour mettre en place les différentes étapes de la conception de votre campagne. Il faudra en effet suivre un cheminement similaire à la création de votre campagne via l'interface Actito.

A tout moment, il vous possible de reprendre en main votre campagne via l'interface Actito.

Mettre en place une campagne e-mail ponctuelle​

Pour créer et envoyer des e-mails de masse entièrement via l'API, nous vous invitons à suivre le use case Daily Newsletter dans notre Developers Portal!

Envoyer des campagnes continues​

Contrairement aux campagnes de masse qui sont envoyées une seule fois, il est possible de programmer des campagnes continues, qui permettront l'envoi continu d'e-mails à un moment spécifique pour chaque profil.

Le fonctionnement des campagnes continues est scénarisé dans le sens qu'elles permettent une automatisation de l'envoi d'un e-mail sur base d'un événement déclencheur. A la différence des scénarios tels qu'ils peuvent être mis en place dans Actito, l'événement déclencheur des campagnes continues ne doit pas être défini dans l'interface. L'envoi sera directement déclenché par un appel webservice que vous pourrez programmer selon l'objet de votre envoi continu (par exemple, un e-mail de bienvenue suite à une inscription, un e-mail de confirmation suite à une commande).

Activer une campagne continue​

L'envoi continu devra préalablement être préparé, comme détaillé dans les opérations précédentes. Il devra ensuite être activé.

Cela se fait via l'opération PUT/entity/{e}/mail/{m}/activate

Vous obtiendrez l'identifiant technique de l'envoi en réponse et la campagne sera dès lors activée.

Contacter un profil avec un envoi continu​

Lorsqu'un profil remplit les conditions liées à l'objet de votre envoi continu, le déclenchement de celui-ci est possible via l'opération POST/entity/{e}/mail/{p}/profile{p}

Les variables​

Cet appel vous permet de soumettre des variables en lien direct avec l'objet de cet envoi continu (par exemple, dans le cadre d'une confirmation de commande, il peut s'agit d'un montant). Ces variables devront directement faire référence à une personnalisation que vous avez inclus dans le corps de votre e-mail. En effet, dans le cadre d'un envoi continu, il n'est obligatoire de définir toutes les personnalisations, contrairement aux e-mails de masse. Celles-ci peuvent être "fournies plus tard", c'est à dire par l'événement déclencheur de l'e-mail continu.

Définir les variables​

Dans le contenu de votre e-mail, les variables devront être définies comme une personnalisation classique, c'est à dire avec le sigle '$' suivi du nom de la personnalisation entre accolades (ex. : *${maPerso}*).

Dans l'appel webservice, elles devront figurer dans le corps de la requête sous forme de paires "key-values", où "key" correspond au nom exact de la personnalisation et où "values" correspond à la valeur que la variable devra prendre dans l'e-mail.

Exemple :

curl -X POST --header "Content-Type: application/json" --header "Accept: application/json" -d "[
{
\"key\": \"amount\",
\"values\": [
\"128\"
]
}
]
" "https://api-pre1.actito.com/v4/entity/actito/mail/203/profile/1147695"