Explorateur d'API
Une interface de programmation d'applications (API) est un moyen pour deux programmes informatiques ou plus de communiquer entre eux. Il s'agit d'un type d'interface logicielle qui offre un service à d'autres logiciels.
Selligent utilise plusieurs API.
La documentation de l'API est disponible depuis le module Explorateur d'API, dans la section Modules de la barre d'outils supérieure. Vous pouvez effectuer des appels d'API directement depuis ce module.
Pour une bibliothèque complète de toutes les méthodes disponibles, consultez la documentation du DevPortal ici. Notez cependant qu'aucun appel d'API ne peut être effectué depuis cette page. Nous vous conseillons d'utiliser le DevPortal comme base de référence et le module Explorateur d'API comme plateforme de test.
Remarque: L'autorisation de lancement doit être définie pour accéder au module Selligent. Cela vous donne accès à la fois au module Selligent et au module Explorateur d'API.
Dans l'explorateur d'API, vous pouvez visualiser et exécuter les opérations des points de terminaison de l'API Selligent, avec leurs méthodes HTTP (GET, POST, PUT, DELETE). Chaque opération présente un modèle et une valeur d'exemple, ainsi que des paramètres permettant de compléter les valeurs. Les détails de la réponse sont affichés lors de l'exécution.
Commencez par entrer la clé d'authentification et la clé secrète dans le coin supérieur droit.
Remarque : Vous devez saisir une clé d'authentification et une clé secrète pour utiliser l'API. Demandez à votre administrateur système d'en générer une.
Dans l'API Explorer, vous trouverez des informations sur l'utilisation d'une méthode et sur les paramètres à transmettre. La méthode peut également être testée.
Chaque section peut être développée, affichant ainsi toutes les méthodes disponibles.
Exemple de réponse:
Le Portail des développeurs fournit une documentation similaire et des options de test, ainsi que des exemples, des réponses, une description des champs, etc. Un journal de modifications est disponible, ainsi qu'un guide expliquant comment obtenir les clés.
L'explorateur d'API est également accessible via l'URL suivante;
http(s)://yourdomain/Portal/Api/swagger
Le Portail des développeurs est accessible à partir de l'URL suivante: https://developers.meetmarigold.com/engage/api/
Pour les Transactional Journeys, vous pouvez également lancer Portail des développeurs avec sa documentation (dans un nouvel onglet) à partir de l'assistant de création de journey en cliquant sur le lien « ici ».
Remarque technique : Une méthode spécifique est disponible pour récupérer l'état du message transactionnel. Pour plus d'informations sur les états possibles renvoyés, consultez cette rubrique dédiée.
Remarque importante : Les en-têtes X-Forwarded-Host personnalisés dans les appels d'API ne sont pas pris en charge.
Explorateur d'API de rendus
L'explorateur d'API de rendus est accessible directement à partir de la section Modules de la barre d'outils supérieure.
Remarque: L'autorisation de lancement doit être définie pour accéder à Campaign et à l'explorateur d'API des moteurs de rendu.
Il est également possible d'y accéder via l'URL suivante :
http(s)://yourdomain/renderers/swagger
L'explorateur d'API de rendus est utilisé pour le rendu de contenu Selligent.
Remarque : L'explorateur d'API et l'explorateur d'API de rendus ont tous deux leur propre documentation interne dédiée.
