L'API Emarsys donne un accès programmatique à la plupart des fonctions de la Plateforme Marketing Emarsys, vous donnant les outils réaliser l'intégration avec nous et automatiser vos campagnes marketing.
- L' Intégration vous permet d'accéder à la plupart des fonctionnalités de la Plateforme Emarsys directement depuis votre propre application.
- L' Automation donne un moyen de configurer des campagnes marketing complexes qui s'exécutent sans besoin d'aucune interaction humaine de votre côté.
À propos du Hub du développeur Emarsys
Nous avons une Liste de tous les API endpoints publics sur ce Portail d'aide, mais le gros de notre contenu technique est sur notre Hub du développeur.
On y trouve des guides, des ressources, des cas d'usage et une référence interactive qui vous aide à réaliser l'intégration avec la Plateforme Marketing Emarsys, afin d'offrir des interactions client personnelles par email, mobile, réseaux sociaux, SMS et web.
Prêts à sauter le pas ? Continuer vers le Hub du développeur Emarsys.
Avant de commencer
Afin de vous faire économiser du temps et d'éviter les erreurs courantes, nous avons rassemblé un certain nombre d'étapes importantes et de concepts de niveau supérieur dont vous devriez avoir connaissance avant de commencer à utiliser l'API Emarsys.
Ne vous inquiétez pas, vous passerez votre premier appel API réussi dans quelques minutes. Mais avant vous devez effectuer quelques tâches administratives :
- Votre entreprise a complété les parties pertinentes de votre parcours d'onboarding : le data onboarding et l'activation des canaux que vous allez utiliser.
- Vous avez lu la section Avant de commencer et vous êtes familiarisé avec les bases du fonctionnement de notre API RESTful et ce qu'il a à offrir.
- Votre responsable du compte a configuré un utilisateur API et une clé secrète correspondante sous Gestion > Paramètres de sécurité. Pour les détails, voir Utilisateurs API.
- Assurez-vous que votre utilisateur API dispose de tous les privilèges d'accès nécessaires. Les privilèges d'accès peuvent être accordés dans la page paramètres de sécurité. Les utilisateurs API n'ont pas tous les privilèges activés par défaut. Si les privilèges ne sont pas correctement configurés, certaines fonctions de l'API ne sont pas utilisables, ce qui peut entraîner une erreur
403 Forbidden. Voir système de permissions API pour plus de détails.
Avant d'utiliser notre API, nous vous recommandons fortement de lire les guides suivants pour prendre connaissance des concepts, de l'architecture et des bonnes pratiques.
- Apprenez les bases - Apprenez les concepts Emarsys fondamentaux et comment notre API RESTful est conçue, y-compris du point de vue authentification, limitation de débit et structures de requête.
- Faites les premiers pas - Suivez notre guide pour devenir opérationnel en un clin d'oeil.
Après avoir complété les premières étapes, visitez l'endpoint de référence pour voir et tester les endpoints disponibles en temps réel avec vos propres données. Nous fournissons aussi des exemples de code, une collection Postman exhaustive ainsi que les spécifications aux formats OpenAPI et RAML sur le hub du développeur.
Ressources
Allez au hub du développeur directement pour trouver des spécifications et définitions d'endpoint.
Toutes les spécifications d'endpoint sont fournies aux formats OpenAPI 2.0 (Swagger) et RAML 0.8, accompagnées d'une collection Postman sur le hub du développeur.
| Section | Sommaire |
|---|---|
| Avant de commencer | Apprenez les concepts Emarsys fondamentaux et comment notre API RESTful API est conçue. |
| Premiers pas | Suivez notre guide pas-à-pas si vous êtes nouveau sur la plateforme. |
| Endpoints | Consultez tous les endpoints disponibles et testez les à la volée avec vos propres données. |
| Personnalisation |
|
| Codes de réponse |
|
| Annexe |
|
| Changelog | Consultez les release notes et suivez les changements liés à l'API Emarsys et au Hub du développeur. |
Options de démo interactive
Expérimentez avant de coder ! Pour vous aider à construire votre intégration, nous proposons plusieurs options pour tester votre implémentation.
Hub du développeur Emarsys
Vous pouvez tester tous les endpoints avec vos données réelles ici même sur le Hub du développeur.
Procédez prudemment, cette fonctionnalité n'est pas un bac-à-sable ! Tout changement apporté aux données de contact ou de campagne aura un effet réel sur votre compte (si vous testez Supprimer un contact, le contact que vous utilisez pour le test sera supprimé).
- Sélectionnez l'endpoint que vous voulez tester.
- Cliquez sur Essayez-le.
- Mettez vous informations d'authentification dans la barre de navigation.
- Fournissez les paramètres requis.
- Cliquez sur Envoyer la requête.
Votre requête est envoyés à nos serveurs et retourne des données réelles.
Des exemples de codes et des spécifications sont aussi à portée de main. Allez à l'onglet Génération de code à la page d'endpoint pour trouver des exemples de code prêts à la production pour chaque endpoint en plusieurs langues. Vous pouvez les insérer dans votre code d'un simple copier/coller.
Les commandes curl sont aussi disponibles dans les exemples de code.
Collection Postman
Si vous préférez Postman, téléchargez nos bibliothèques classées par catégories qui contiennent tous les endpoints accompagnés d'exemples.
Vous devez calculer la valeur d'en-tête WSSE manuellement quand vous utilisez Postman et l'insérer dans l'en-tête X-WSSE.
La page de démo d'API
Nous fournissions une page de démo où vous pouvez expérimenter avec les capacités de l'API. Elle possède une interface utilisateur graphique qui permet l'expérimentation avec les requêtes API et leurs paramètres. Les réponses sont ensuite affichées pour que les utilisateurs puissent voir à quoi s'attendre.
- Pour accéder l'environnement de démo, visitez https://api.emarsys.net/api-demo.
- Pour vérifier que les données d'accès sont valides, faites une requête test pour voir quelles langues sont disponibles. Pour cela, allez à l'onglet Champs de contact. Laissez le Code de langue vide et cliquez sur OK. La réponse apparaîtra à droite de la même page, contenant certaines informations sur la requête. Le tableau suivant montre les réponses possibles et les raisons de l'échec.
| Réponse (replyCode, replyText) | Raison possible | Solution suggérée |
|---|---|---|
| 0, OK | Vous avez réussi, et vos identifiants ont été acceptés. | Vous devriez voir la liste des langues. |
| 1, Non-autorisé | Quelque chose ne va pas avec vos identifiants. | Vérifiez à nouveau vos informations d'accès. |
| Aucune réponse du tout |
|
|
La réponse de votre requête apparaît toujours dans le coin supérieur droit de la page, donc après avoir envoyé une requête n'oubliez pas que vous devrez peut-être scroller vers le haut pour voir la réponse.
Ligne de commande
Relances d'API
Il est avisé d'inclure des mécanismes de relance dans les workflows qui utilisent les appels API.
Les messages d'erreur après l'échec d'une tentative d'appel API peuvent provenir de problèmes temporaires, locaux ou globaux, de connexion au réseau. Diverses erreurs et pannes affectant le succès de votre communication peuvent survenir en dehors de nos systèmes. Dans ce cas, le problème peut souvent être résolu par une simple relance.
Un bon exemple d'un workflow où un mécanisme de relance peut aider est quand vous recevez des réponses "HTTP 503 / The system is overloaded for this resource." à votre appel.
Spécifiez l'heure de la relance, en vous assurant qu'elle n'est pas faite juste après la réception d'une erreur HTTP 503. Laissez passer 3-4 minutes avant la tentative de relance d'API, ou bien planifiez-la à une période complètement inactive de votre côté, de sorte à ne pas envoyer plusieurs appels simultanément.