URL https://api.dpmail.fr/json/Subscriber.ImportByUrl.php
Permet d'importer un grand nombre de contacts dans une liste en une seule fois. Cette méthode télécharge un fichier CSV encodé UTF-8 via une URL passée en paramètre.
L'import se déroule en tâche de fond, le temps de réponse de l'API est donc très court et indépendant du nombre de ligne contenu dans le fichier CSV.
Un identifiant unique nommé TaskID est retourné en réponse. Il faut utiliser la méthode Subscriber.ImportByUrlGetStatus pour connaitre l'état d'avancement de l'import.
Paramètres et infos requises
ListId - String
L'identifiant de la liste à laquelle ajouter les abonnés.
Url - String
Une adresse Web à laquelle se trouve le fichier CSV.
Options - Array
Un tableau d'option permettant d'adapter le fonctionnement de l'import:
Options disponibles :
- update_existing (défaut: true) : Si l'adresse email existe déjà dans la liste, les données de l'abonnés seront mises à jour.
- resubscribe (défaut: false) : Si l'adresse email correspond a un abonné désinscrit de la liste, il sera ré-inscrit.
Codes de retour
Succès
0: Success
Les données sont correctes, l'import va se réaliser d'ici quelques instants.
Erreur
12: URL inaccessible
L'adresse passée dans le paramètre Url n'a pas pu être contactée. Vérifiez que le
fichier existe, et que le parefeu autorise les connexions.
301: ListID Invalide
ListID doit être une chaine de 32 caractères. La liste dans laquelle vous voulez
importer les abonnés doit appartenir au compte lié à votre clé API.
Format du fichier CSV
Le fichier CSV doit être encodé en UTF-8, les champs doivent être séparés par des ;
Si les champs de données contiennent des points virgule, alors il doivent obligatoirement être entourés de guillemets.
Le fichier doit contenir une ligne d'entête, sur la première. Le nom des entêtes doit correspondre au nom des champs standard de la plateforme, à savoir :
- first_name
- last_name
Si vous souhaitez ajouter des données pour les champs personnalisés, les entêtes doivent porter le nom du champ tel qu'il apparait dans l'écran de gestion des champs personnalisés de l'application.
Par exemple pour un champ dont le tag est {$Member.code_postal}, il faudra utiliser l'entête code_postal.
Format des données en sortie
{
"TaskID" : "32a9ef46d35eb4cc84261ab61da216fa"
}