Aller au contenu principal

API des données de résultats

Mise à jour

L’API des données de résultats de SHOEBOX Online permet aux organisations de récupérer automatiquement les données des résultats de test de leurs participants depuis SHOEBOX Online et de les envoyer à d’autres applications logicielles, telles que les logiciels de gestion de la relation client ou un système de marketing par courriel.

Schéma illustrant comment l'API récupère des données depuis SHOEBOX Online et les transfère vers une application tierce.

Dans cet article :

Limitations

  • Seuls les utilisateurs administrateurs peuvent accéder aux paramètres de l’API dans le Portail de gestion des données.
  • L’API des données de résultats ne peut être utilisée que pour extraire des données du stockage sécurisé dans le cloud de SHOEBOX Online. Elle ne prend pas en charge l’envoi de données vers SHOEBOX Online ni la modification des données existantes dans SHOEBOX Online.
  • L’API des données de résultats ne peut être utilisée que pour envoyer les données directement à l’application de destination. Elle ne fonctionnera pas correctement si les données passent par un logiciel intermédiaire (middleware) ou tout autre logiciel tiers intermédiaire.
  • Les résultats des tests sont stockés une seule fois dans la file d’attente de l’API et restent disponibles dans cette file d’attente pendant un maximum de quatre jours avant d’être supprimés. Une fois que les résultats de test ont été extraits de la file d’attente via l’API, ils ne sont plus dans la file d’attente et ne peuvent pas être extraits de nouveau. Cependant, les résultats des tests de vos participants sont toujours disponibles dans le Portail de gestion des données SHOEBOX.

Configuration de l’API

Pour commencer à configurer une connexion API, vous devez configurer vos paramètres d’API dans le Portail de gestion des données. Seuls les utilisateurs ayant un rôle d’administrateur peuvent accéder à ces paramètres. Si vous êtes un utilisateur administrateur, mais que vous n’êtes pas familier avec le travail avec les API, nous recommandons de demander l’aide de l’équipe de développement de votre organisation pour configurer les paramètres de l’API.

Dans les paramètres de l’API, vous devrez :

  1. Activer l’API.
  2. Créer la clé API de votre organisation.
  3. Obtenir le point de terminaison (endpoint) API de votre organisation.

Optionnellement, vous pouvez aussi configurer un webhook de notification. Pour des descriptions plus détaillées de ces paramètres, consultez Paramètres de l’API.

Pour configurer les paramètres de l’API

  1. Connectez-vous au Portail de gestion des données SHOEBOX.
  2. Dans la barre latérale, survolez l’onglet « Paramètres ».

  3. Sous la rubrique « SHOEBOX Online », cliquez sur « Avancé ».

    Emplacement de l’onglet « Avancé » pour SHOEBOX Online dans le portail web

  4. Dans le coin supérieur droit de la page « Avancé », cliquez sur « Modifier ».

  5. Pour activer l’API, basculez l’interrupteur sur ON dans le coin supérieur droit de la section « API des résultats SHOEBOX Online ».

    A screenshot of the toggle switch to enable the SHOEBOX Online Results Data API.

  6. Pour créer une nouvelle clé API, cliquez sur le bouton « Créer une nouvelle clé API ».

    Une capture d'écran du bouton dans les paramètres de l'API qui permet de générer la clé API.
    • Important : Les clés API ne sont générées qu’une seule fois. Si vous créez une nouvelle clé API après en avoir déjà généré une, la clé API précédente sera révoquée et cela interrompra votre connexion API.
  7. Pour obtenir votre point de terminaison API, cliquez sur le bouton « Copier » à côté du champ point de terminaison API. Votre équipe de développement aura besoin de ce point de terminaison pour se connecter à l’API.
  8. Après avoir effectué vos modifications, cliquez sur « Enregistrer » dans le coin supérieur droit.

Votre équipe de développement devra ensuite ajouter l’URL du point de terminaison de votre organisation à votre application tierce. Pour une documentation et des exemples supplémentaires, consultez Ressources pour développeurs. Une fois connectée à l’API, les nouveaux résultats de test seront automatiquement intégrés dans votre application tierce.

Paramètres de l’API

Cette section décrit les paramètres pour l’API des données de résultats.

Accéder aux principaux paramètres de l’API avec l’API de résultats SHOEBOX Online activée
  1. Documentation : Liens vers un document API ouvert contenant la documentation technique que votre équipe de développement peut utiliser pour configurer le transfert automatisé des données.
  2. Clé API : Cliquer sur le bouton « Créer une nouvelle clé API » génèrera une nouvelle clé API unique à votre organisation. La clé API est requise pour se connecter à l’API des données de résultats.
  3. Point de terminaison API : C’est le répertoire où votre équipe de développement indiquera à l’API des données de résultats où envoyer vos données. Le point de terminaison API est requis pour se connecter à l’API des données de résultats.
  4. URL du webhook de notification : Ici, vous pouvez activer ou désactiver le webhook de notification. En activant un webhook de notification, vous pouvez immédiatement extraire les données des prospects dans votre application tierce après chaque test complété, au lieu de programmer des extractions de données. Ceci est important si vous utilisez SHOEBOX Online pour générer des prospects, car contacter les prospects dans les quelques heures qui suivent augmente significativement le taux de conversion. Pour activer correctement votre webhook de notification, vous devrez collaborer avec votre équipe de développement afin de vous assurer que la bonne URL est placée dans le champ URL.

Ressources pour développeurs

Les ressources API pour les développeurs sont présentées ci-dessous :

Projet Github de démarrage rapide

Un projet d’exemple qui démontre comment appeler avec succès l’API des données de résultats et récupérer les données des participants. Pour voir le projet d’exemple, consultez SHOEBOX Online API quickstart node.

Documentation technique

Un document API ouvert contenant des informations techniques, y compris un point de terminaison, des descriptions de paramètres et une réponse d’exemple. Pour voir le document API, consultez SHOEBOX Online customer API.

Associé à

Articles associés