Syntaxe ‘Action’

C’est avec plaisir que nous annonçons le lancement de nouvelles routes d’action pour notre API newsletter. Grâce à cette mise à jour, vous pourrez gérer le contenu et l’envoi de votre newsletter.

Pour commencer, nous ajoutons quatre possibilités ‘d’actions’ à la route de la newsletter :

  • /detailcontent
  • /schedule
  • /send
  • /test

Chaque ‘action’ associée à la route de l’API newsletter et à l’ID de cette newsletter exécute sa fonction. Ces nouvelles routes deviennent :

  • https://api.mailjet.com/v3/REST/newsletter/:id/detailcontent
  • https://api.mailjet.com/v3/REST/newsletter/:id/schedule
  • https://api.mailjet.com/v3/REST/newsletter/:id/send
  • https://api.mailjet.com/v3/REST/newsletter/:id/test

Il vous suffit de remplacer ‘:id’ par le véritable ‘:id’ numérique de la newsletter (par ex. http://api.mailjet.com/v3/REST/newsletter/3/detailcontent) et vous pourrez commencer à créer, tester et envoyer vos newsletters !


/detailcontent

/detailcontent vous permet de gérer le contenu d’une newsletter : créer, modifier une partie du HTML ou le texte. Vous pouvez créer, mettre à jour, visualiser et supprimer n’importe quel contenu d’une newsletter spécifique avant de l’envoyer. Pour ce faire, ajoutez simplement le contenu dans le JSON de la newsletter.

Exemple de code
Méthodes acceptées
POST, GET, PUT, DELETE

Créer le contenu de la newsletter
Pour gérer le contenu de votre newsletter, lancez une requête POST avec ‘Text-part’ et ‘Html-part’ dans une structure JSON. Souvenez-vous, si la requête POST est lancée et que l’un des deux paramètres mentionnés est manquant, celui-ci sera supprimé dans la newsletter en question. Pour l’éviter, utilisez une requête PUT (voir ci-dessous). Inutile de de pousser du contenu POST avant de mettre à jour, puisque seul l’HTML ou le texte est requis.

Afficher le contenu d’une newsletter Pour visualiser le contenu d’une newsletter, lancez une requête GET

Cela va retourner le résultat suivant :

Mettre à jour le contenu d’une newsletter Pour mettre à jour ‘Html-part’ ou ‘Text-part’, exécutez une requête PUT. Contrairement à l’appel de POST sur cette route, si l’un de ces attributs n’est pas présent dans la structure JSON, il ne sera pas supprimé. Cela permet d’effectuer des mises à jour partielles du contenu de la newsletter. Supprimer le contenu d’une newsletter


/schedule

/schedule vous permet de programmer la date d’envoi de la newsletter. Pour ce faire, ajoutez simplement dans le JSON la date au format ISO 8601 à laquelle vous souhaitez l’envoyer. Vous pouvez également sélectionner “NOW” au lieu d’un timestamp pour l’envoyer immédiatement. Dans ce cas, vous pouvez également utiliser la méthode ‘/send’ décrite plus bas.

Avant d’accepter la méthode ‘/schedule’, l’API vérifiera que toutes les informations nécessaires de la newsletter ont bien été créées : nom et adresse email de l’expéditeur, objet, statut de la newsletter et HTML/texte. Si l’une de ces informations venait à manquer, l’API vous retournerait une erreur que vous pourrez corriger avant de réessayer.

Exemple de code

Méthodes acceptées
POST, DELETE

Programmer une newsletter
Pour programmer une newsletter à l’avance, lancez une requête POST avec la date au format ISO 8601 à laquelle vous souhaitez l’envoyer :

Annuler une newsletter Pour annuler l’envoi d’une newsletter, lancez une requête DELETE :


/send

/send vous permet d’envoyer une newsletter. Cet appel d’API revient à utiliser, comme mentionné ci-dessus, “NOW” au lieu d’un timestamp dans la route d’action de la méthode ‘/schedule’.

Comme pour ‘/schedule’, avant d’accepter la méthode ‘/test’, l’API vérifiera que toutes les informations nécessaires de la newsletter ont bien été créées : nom et adresse email de l’expéditeur, objet, statut de la newsletter et HTML/texte. Si l’une de ces informations venait à manquer, l’API vous retournerait une erreur que vous pourrez corriger avant de réessayer.

Exemple de code

Méthodes acceptées
POST

Envoyer une newsletter maintenant
Pour envoyer immédiatement une newsletter, lancez une requête POST :

/test

/test vous permet d’envoyer une newsletter en test à une adresse email de votre choix pour vous assurer que vous n’avez rien oublié avant de l’envoyer à tous vos clients. Pour ce faire, ajoutez simplement le nom et l’adresse email du destinataire du test dans le JSON de la newsletter. Comme pour ‘/schedule’ et ‘/send’, avant d’accepter la méthode ‘/test’, l’API vérifiera que toutes les informations obligatoires de la newsletter ont bien été renseignées : nom et adresse email de l’expéditeur, objet, statut de la newsletter et HTML/texte. Si une de ces informations venait à manquer, l’API vous retournerait une erreur que vous pourrez corriger avant de réessayer. Exemple de code Méthodes acceptées POST Envoyer un test Pour envoyer une newsletter en test, effectuez une requête POST :

Documentation
Vous pouvez consulter tous les ajouts à notre documentation ‘/newsletter’ ici.

FAQ

J’ai déjà intégré les fonctions “création” et “envoi” via l’API. Qu’est-ce que cela veut dire pour moi ? Est-ce que je dois réécrire mon code ?

Non, mais nous vous conseillons grandement de jeter un œil à nos nouvelles routes ‘d’action’ et de les intégrer. Surtout, sachez que vous n’avez pas à changer les logiciels que vous avez mis en place si vous n’en avez pas envie. Notre API newsletter ne présente pas cette contrainte.

Je ne trouve toujours pas ma clé API ni ma clé secrète. Où puis-je les trouver ?
Vous pouvez les trouver ici.