Table des matières
- 1 API SOAP
- 1.1 Introduction
- 1.2 Comment accéder à l'API SOAP
- 1.3 Informations sur le compte
- 1.4 Informations sur les campagnes
- 1.5 Interaction avec les campagnes classiques
- 1.6 Module base de données
- 1.7 Campagnes spécifiques à l'API (modèles de campagnes envoyées au fil de l'eau)
- 1.8 Les scénarios
- 1.9 Section revendeurs / multi-comptes
- 2 API SMTP
- 3 API de gestion des désabonnements
- 4 API REST
- 5 API SMS
API SOAP
Introduction
Comment accéder à l'API SOAP
Informations sur le compte
Récupérer le crédit restant sur son compte
Informations sur les campagnes
Liste des campagnes associés à son compte
Interaction avec les campagnes classiques
Paramétrer une campagne
Récupérer les paramètres d'une campagne
Modifier les paramètres d'une campagne
Email de l'expéditeur / Gestion automatique des retours
Ajouter des adresses via une URL
Vérifier le statut de l'importation de destinataires dans une campagne via une URL
Dédoublonner et nettoyer le fichier de destinataires
Vérifier l'adresse email
Vérifier qu'une adresse email n'est pas désinscrite :
Vérifier la présence d'un email dans votre blackliste
Vérifier qu'une adresse email n'est pas revenue en NPAI hard lors de l'une de vos précédentes campagnes :
Vérifier la présence d'un email dans votre liste de NPAI
Envoyer une campagne
Fonctions de commande d'une campagne :
Récupération des données d'une campagne
Récupération des données d'une campagne en fonction du comportement des destinataires :
Récupérer les NPAI d'une campagne
Récupérer les ouvreurs d'une campagne
Récupérer les cliqueurs d'une campagne
Récupérer les désinscrits d'une campagne
Récupérer les non actifs d'une campagne (tous les autres)
Récupérer statistiques d'une campagne
Récupérer la liste des destinataires d'une campagne
Construire un lien vers une page de MDWorks
Construire le lien vers la page de statistiques d'une campagne
Lien vers le message hébergé d'une campagne
Gérer les désinscriptions
Ajouter une adresse à la liste des désinscrits du compte
Récupération massive de données
Ces fonctions permettent de mettre à jour votre base de données à intervalles réguliers :
Récupérer tous les NPAI depuis une période
Récupérer tous les ouvreurs depuis une période
Récupérer tous les désinscrits depuis une période
Récupérer l'ensemble des emails désinscrits sur votre compte
Module base de données
Ces fonctions permettent de synchroniser votre base de données avec celles de votre compte MDWorks :
Récupérer la structure d'une base de données
Ajouter une ligne dans une base de données
Rechercher dans une base de données
Supprimer une ligne dans une base de données
Campagnes spécifiques à l'API (modèles de campagnes envoyées au fil de l'eau)
Introduction
Le principe des modèles de campagnes
Fonctionnalités communes avec les campagnes classiques
Récupérer les paramètres d'une campagne
Récupération des données d'une campagne en fonction du comportement des destinataires :
Récupérer les NPAI d'une campagne
Récupérer les ouvreurs d'une campagne
Récupérer les cliqueurs d'une campagne
Récupérer les désinscrits d'une campagne
Récupérer les non actifs d'une campagne (tous les autres)
Récupérer statistiques d'une campagne
Récupérer la liste des destinataires d'une campagne
Vérifier qu'une adresse email n'est pas désinscrite :
Vérifier la présence d'un email dans votre blackliste
Vérifier qu'une adresse email n'est pas déjà présente dans la base des destinataires d'une campagne gérée via l'API (pour éviter les doublons si besoin) : Vérifier la présence d'une adresse email dans le fichier des destinataires
Récupérer l'ensemble des emails désinscrits sur votre compte
Vérifier qu'une adresse email n'est pas revenue en NPAI hard lors de l'une de vos précédentes campagnes :
Vérifier la présence d'un email dans votre liste de NPAI
Fonctionnalités spécifiques aux modèles de campagnes
Listes des campagnes accessibles via l'API
Ajouter une adresse et envoyer le mail
Les scénarios
Introduction
Fonctionnalités
Ajouter un destinataire dans la boucle d'un scénario
Récupérer la liste des destinataires d'un scénario
Section revendeurs / multi-comptes
Introduction
Gérer les sous-comptes
Modifier l'email et le nom d'expéditeur d'un sous-compte
Ajouter un crédit d'envoi à un sous-compte
API SMTP
API de gestion des désabonnements
Documentation gestion des désabonnements
API REST
Documentation de l'API HTTP / REST
API SMS
Récupérer le nombre de crédit d'un compte
Documentation de l'API SMS (un message identique pour un ou plusieurs destinataires)
Documentation de l'API SMS V2 (personnalisation du message pour chaque destinataire)
Revendeurs : Ajouter un crédit d'envoi SMS à un sous-comptes
This post is also available in: English (Anglais)