Les services Web de Dialog Insight sont des API REST accessibles via HTTPS en utilisant une authentification par clé d'API (les requêtes et les réponses sont au format JSON). Les services Web permettent aux développeurs d’intégrer la plateforme à leurs propres systèmes et applications. Grâce aux API, vous pouvez automatiser la gestion des contacts, déclencher des campagnes marketing, synchroniser des données et récupérer des statistiques en temps réel. Dans cet article, vous aurez un aperçu global des services Web, de leur fonctionnement, ainsi que des cas d’utilisation courants.
Liens vers la documentation Canada : https://app.dialoginsight.com/fe/webservices/aboutFrance : https://app.mydialoginsight.com/fe/webservices/about |
Plusieurs actions CRUD peuvent être faites lors d'appels aux services Web :
- Lire ou modifier des données (contacts, segments, campagnes, etc.)
- Connecter Dialog Insight à des systèmes tiers (CRM, ERP, e-commerce)
- Automatiser des tâches marketing récurrentes
- Récupérer des rapports et indicateurs de performance
Catégories principales de endpoints
Gestion des contacts
Manipulation de la ressource la plus centrale de la plateforme : les contacts.
- Créer un contact (Contacts.Merge)
- Mettre à jour un profil (Contacts.Merge)
- Rechercher ou filtrer des contacts (Contacts.Get)
Segmentation et ciblage
Travail sur les listes et segments pour cibler vos envois.
- Lister les segments disponibles
- Obtenir les contacts d’un segment
- Créer ou mettre à jour un segment dynamique
Campagnes et communications
Gestion des campagnes courriel, SMS ou autres canaux.
- Créer une campagne
- Déclencher une campagne
- Planifier ou déclencher un envoi
- Obtenir les statistiques d’une campagne
Données et statistiques
Extraction d’informations pour analyser vos actions marketing.
- Récupérer les rapports d’ouvertures et clics
- Obtenir l’historique des envois par contact
Nomenclature des champs
Pour appeler un champ de projet par services Web, vous devez ajouter un préfixe avant l'identifiant interne du champ. Pour voir l'identifiant interne d'un champ, rendez-vous dans la liste des champs : Projet → Gestion des données → Champs de projet.
Champs de contact
Préfixe : f_
Exemple : f_FirstName
Clé de projet
Préfixe : key_f_
Exemple : key_f_EMail
Champs d'abonnement
Préfixe : optin_
Exemple : optin_Newsletter
Cas d’utilisation typiques
Voici quelques exemples concrets d’appels que vous pourriez mettre en place dès vos premiers développements.
Inscription à une infolettre : Lorsqu’un visiteur soumet un formulaire, votre site appelle l’API pour créer son profil ou le mettre à jour dans Dialog Insight. Le statut d'abonnement à l'infolettre est également mis à jour.
Mise à jour des données client : Un changement d'information (nom, prénom, adresse) pour un contact dans votre CRM déclenche un appel API pour synchroniser l'information au profil dans Dialog Insight.
Relance intégrée à une campagne automatisée : Votre système e-commerce détecte un panier abandonné et appelle un scénario automatisé (une campagne automatisée) dans Dialgo Insight. Le scénario déclenche l'envoi, par courriel ou SMS, d'un rappel des articles laissés dans le panier.
Tableau de bord interne : Une interface maison interroge l’API DI pour afficher en temps réel le taux d’ouverture des dernières campagnes.
Bonnes pratiques à respecter
- Commencez petit : Testez vos appels dans un environnement de développement avant de viser des synchronisations massives.
- Utilisez la documentation officielle : Chaque point d’entrée d’API est documenté avec ses paramètres et exemples.
- Gérez les réponses des appels : Prévoyez la gestion des rétroactions et des codes de statut HTTP (ex. 400, 401, 404, 500).
- Respectez les limites d’appels : Évitez les boucles d’appels intensives qui peuvent impacter les performances et ne faites pas d'appels massifs qui dépasseraient les limites d'envois des services Web.