Dans cet article nous vous listons les 4 étapes à suivre pour exporter le fichier des désabonnés des 7 derniers jours d'une base de données par exemple.
Tout d'abord pour pouvoir réaliser un export via API, il vous faut un compte API.
Lors de la création de votre base de données, si vous en avez fait la demande dans le formulaire d'ouverture de base, alors un compte API a été créé et les logins / mots de passe vous ont été transmis.
Si vous n'en aviez pas fait la demande lors de la création de votre base de données, ou si vous ne vous souvenez plus de votre mot de passe, demandez à votre administrateur de vous créer l'accès ou de réinitialiser le mot de passe associé au compte API de la base. Pour rappel, il ne peut y avoir que deux comptes API par base de données maximum (un en accès complet, et un en accès restreint).
👉 On vous explique tout ici sur la gestion des comptes API de vitre société
Ci-dessous les 4 étapes à suivre. A chaque étape vous trouverez un lien vers notre documentation sur l'API où vous aurez la liste des paramètres, les opérateurs, etc... Vous pourrez grâce à cela adapter cet export à vos besoins précis.
1. Vous authentifier en récupérant votre jeton d'authentification, aussi appelé "Token"
👉 on vous explique ici comment
❗Les deux prochaines étapes seront à faire uniquement en initialisation. Il n'est pas nécessaire de recréer la cible pour chaque export, vous pouvez réutiliser celle créée la première fois. ❗
2. Créer une cible sur l'API en appelant POST api/{idsite}/Targets.
👉 on vous explique ici comment
Vous avez créé une cible mais aucun filtre n'est défini.
Donc à ce stade, la cible n’est pas encore utilisable et ne peut pas apparaître dans le gestionnaire de cibles dans l’interface.
Pour que la cible soit valide, il faut qu’elle possède au moins un filtre.
Pour en créer un, vous pouvez utiliser l'appel correspondant au type de filtre souhaité.
Dans le cas présent il vous faut ajouter des filtres par champ.
3. Ajouter des filtres à la cible créée
👉 on vous explique ici comment
Voici l'appel correspondant : POST api/{idsite}/targetfilters/{idTarget}/field
Les 2 critères à insérer pour notre exemple sont :
- état de l'abonné = désabonné ou désabonnement manuel (vous pouvez séparer les valeurs par des ";" pour traduire ce OU)
- date de désabonnement = il a moins de 7 jours, pour exporter les désabonnés des 7 derniers jours par exemple
Paramètres à passer pour ajouter les filtre de l'exemple : (le XXXX correspond à l'id de la cible pré créée)
{"idTarget": XXXX,
"isEnabled": true,
"filters":
[
{"idField": 7,
"operator": 3,
"value": "1;2"}
,
{"idField": 4,
"operator": 11,
"value": "7"}
]
4. Une fois la cible créée, il vous faut donc l'exporter
Pour créer un export de cible vous devez utiliser l’appel POST api/{idsite}/exports/subscribers
Le module d’export permet d’exporter une liste d’emails avec leurs champs. Et pour définir la population exportée, vous utilisez une cible créée en amont.
Dans l'appel API, vous devrez passer les paramètres requis tels que l'ID de la cible à exporter, le nom à attribuer au fichier à exporter, les champs souhaités, l'emplacement sur le sftp, l'encodage, etc...
👉 on vous donne ici la liste des paramètres à passer
Une fois l'appel API paramétré, il vous suffira de le déclencher à la fréquence choisie dans la cible.
Ici dans l'exemple nous souhaitons exporter les désabonnées des 7 derniers jours. Vous devrez donc lancer cet appel tous les 7 jours.