L'API Emarsys donne un accès de programmation à la plupart des fonctions de la Plateforme Marketing Emarsys, vous fournissant les outils pour réaliser votre intégration à Emarsys 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' Automatisation vous permet de configurer des campagnes marketing complexes qui fonctionnent sans aucun besoin d'interaction humaine de votre part.
A propos du Hub du développeur Emarsys
Nous avons bien une Liste de tous les endpoints d'API publics sur ce portail d'aide, mais le gros de notre contenu technique se trouve sur notre Hub du développeur.
Cette ressource propose des guides, des ressources, ces cas d'utilisation et une référence interactive qui vous assistent dans l'intégration avec la Plateforme Marketing Emarsys, afin d'offrir des interactions client personnalisées par email, mobile, réseaux sociaux, SMS et Web.
Prêt à sauter le pas ? Rendez-vous sur le Hub du développeur Emarsys.
Avant de commencer
Afin de vous faire économiser du temps et éviter les écueils communs, nous avons rassemblé un nombre important d'étapes et de concepts de niveau supérieur que vous devriez avoir à l'esprit avant de commencer à utiliser l'API Emarsys.
Ne vous inquiétez pas, seules quelques minutes vous séparent de votre premier appel d'API réussi. Mais vous devez d'abord régler une ou deux questions administratives.
- Votre entreprise a rempli les parties pertinentes de votre parcours d'intégration: intégration des données et activation des canaux que vous utiliserez.
- Vous avez lu la rubrique Avant de commencer et vous êtes familiarisé avec les bases du fonctionnement de notre API RESTful et ce qu'elle 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 plus de détails, consultez Utilisateurs API.
Avant d'utiliser notre API, nous vous conseillons fortement de lire les guides suivant pour vous familiariser avec les concepts, l'architecture et les bonnes pratiques.
- Apprenez les bases - Apprenez les concepts clés Emarsys et comment notre API RESTful est conçue, y compris en ce qui concerne l'authentification, la limitation de taux et les structures de demande.
- Faites les premiers pas - Suivez notre guide pour démarrer en un clin d'oeil.
Après avoir complété les premières étapes, visitez la référence de point d'extrémité pour voir et tester les points d'extrémité disponibles en temps réel avec vos propres données. Nous fournissons aussi des échantillons de code, une collecte Postman exhaustive ainsi que des spécifications aux formats OpenAPI et RAML sur le hub du développeur.
Ressources
Rendez-vous directement sur le hub du développeur pour trouver les spécifications et définitions d'endpoint.
Toutes les spécifications de point d'entrée sont fournies aux formats OpenAPI 2.0 (Swagger) et RAML 0.8, ainsi que sous la forme de collecte Postman sur le hub du développeur.
| Section | Table des matières |
|---|---|
| Avant de commencer | Familiarisez-vous avec les concepts Emarsys clés et la manière dont notre API RESRful est conçue. |
| Premiers pas | Suivez notre guide pas à pas si vous êtes nouveau sur la plateforme. |
| Points d'extrémité | Consultez les points d'extrémité disponibles et testez-les à la volée avec vos propres données. |
| Personnalisation |
|
| Codes de réponse |
|
| Glossaire |
|
| Annexe |
|
| Journal des modifications | leConsultez les notes de release et suivez les changements concernant l'API Emarsys et Hub du développeur. |
Options de démo interactives
Expérimentez avant de coder ! Pour faciliter votre intégration, nous offrons diverses options pour tester votre implémentation.
Le Hub du développeur Emarsys
Vous pouvez tester chaque point d'extrémité avec vos données réelles juste ici sur le Hub du développeur.
Soyez prudent, cette fonctionnalité n'est pas un bac à sable ! Toute modification des données de contact ou de campagne aura un impact réel sur votre compte (c'est-à-dire que si vous testez Supprimer Contact, le contact que vous utilisez pour le test sera supprimé).
- Sélectionnez le point d'extrémité que vous voulez tester.
- Cliquez sur L'essayer.
- Saisissez vos information d'authentification dans la barre de navigation.
- Fournissez les paramètres demandés.
- Cliquez sur Envoyer la demande.
Votre demande est envoyée à nos serveurs et obtient des données réelles en retour.
Les échantillons de code et les spécifications sont aussi à portée de main. Allez sur l'onglet Génération de code sur la page de point d'extrémité pour trouver des échantillons de code prêts à la production pour chaque point d'extrémité en diverses langues. Vous pouvez l'insérer dans votre code d'un simple copié/collé.
Des commandes Curl sont aussi disponibles dans les échantillons de code.
Collecte Postman
Si vous préférez Postman, téléchargez nos bibliothèques spécialisées qui contiennent tous les points d'entrée accompagnés d'exemples.
Vous devez computer la valeur d'en-tête manuellement quand vous utilisez Postman et l'insérer dans l'en-tête X-WSSE.
La page de Démo de l'API
Nous fournissons une page de démo où vous pouvez expérimenter les capacités de l'API. Celle-ci est dotée d'une interface utilisateur permettant l'expérimentation avec les demandes API et leurs paramètres. Les réponses sont ensuite affichées de sorte que les utilisateurs puissent voir à quoi s'attendre.
- Pour accéder à l'environnement de démo, rendez-vous sur https://api.emarsys.net/api-demo.
- Pour vérifier la validité des données d'accès, formulez une demande test pour voir quelles langues sont disponibles. Pour ce faire, allez à l'onglet Champs de contact. Laissez champ de code de langue vide et cliquez sur OK. La réponse apparaîtra sur la droite de la même page, accompagnée de quelques informations sur la demande. Le tableau suivant montre les réponses possibles et les raisons d'un é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é | Il y a un problème avec vos identifiants. | Vérifiez à nouveau vos informations d'accès. |
| Aucune réponse du tout |
|
|
La réponse à votre demande apparaît toujours dans le coin en haut à droite de la page, donc après avoir envoyé une demande, n'oubliez pas qu'il vous faudra peut-être faire défiler vers le haut pour voir la réponse.
