Customer Experience
Employee Experience
Brand Experience
Core XM
Design XM

Prise en main de l’API Qualtrics

À propos de l’API Qualtrics

L’API Qualtrics peut être utilisée pour automatiser des processus répétitifs au sein de Qualtrics ou pour transmettre des informations au sein et à l’extérieur de Qualtrics. Par exemple, un Administrateur d’entreprise peut utiliser l’API Qualtrics pour automatiser le processus de création de compte plutôt que de créer des centaines de comptes individuellement. De même, un utilisateur peut automatiser la création de listes de contacts plutôt que de compiler et d’importer manuellement des listes de contacts. Qualtrics propose également plusieurs guides de solution API qui peuvent vous aider à déterminer la meilleure façon d’utiliser l’API selon vos besoins.

Attention : l’implémentation d’extensions d’API peut nécessiter des connaissances en programmation. Notre équipe d’assistance ne pourra pas vous aider sur les sujets touchant au codage personnalisé. Vous pouvez plutôt tenter de vous adresser à notre communauté d’utilisateurs dédiés. Si vous souhaitez en savoir plus sur nos services de codage personnalisés, veuillez contacter votre Responsable de compte Qualtrics.

Accès API pour différents produits

Qualtrics propose différents produits vous permettant de collecter des données exploitables en temps réel. Certains de ces produits incluent la Plateforme d’enquête, Site Intercept et le Répertoire XM (Target Audience). Après avoir acheté la fonctionnalité API Qualtrics, vous pourrez l’utiliser avec tous les produits faisant partie de votre licence.

Voici des liens vers la documentation de la dernière version de l’API pour chacun de nos produits :

Pour connaître les dernières API de la plupart des produits, voir API Qualtrics.
Site Intercept

Veuillez noter que nous recommandons toujours à nos clients d’utiliser la dernière version de l’API.

Comprendre l’API Qualtrics v3

L’API Qualtrics v3 est une API REST qui vous permet de communiquer avec notre système ou de l’interroger à l’aide d’une syntaxe d’URL simple. La communication avec le système Qualtrics peut être considérée comme une séquence de demandes. Vous pouvez demander que des informations soient envoyées à Qualtrics, mises à jour, supprimées ou renvoyées vers votre système. Ces demandes peuvent être effectuées par des requêtes GET, POST, PUT ou DELETE qui renvoient des réponses JSON.

Ces méthodes permettent à l’API Qualtrics d’interagir avec des éléments du système Qualtrics et d’intégrer ces domaines à votre CRM.

Démarrer

Pour plus d’informations sur la prise en main de l’API Qualtrics, consultez Démarrage rapide de l’API Qualtrics.

Paramètres de passage

Les paramètres sont les éléments constitutifs de vos demandes. Chaque demande API nécessite la transmission de plusieurs paramètres globaux à Qualtrics, ainsi que de plusieurs paramètres spécifiques à la demande et de quelques paramètres facultatifs.

Vous devrez malgré tout transmettre le jeton API dans l’en-tête de la demande sous la forme X-API-JETON. En fonction de la demande spécifique en cours d’exécution, vous devrez peut-être transmettre d’autres paramètres dans l’en-tête, l’URL ou le corps de la demande. Lorsque vous transmettez des paramètres dans le corps, vous devez les envoyer au format JSON. Lorsque vous utilisez cette méthode, vous devez préciser un type de contenu (c’est-à-dire application/json ou multipart/form-data).

Exemple : dans l’exemple POST suivant, dans cURL, nous spécifions l’ URL de base, le type de contenu et le jeton dans l’en-tête. L’ID de l’enquête et le format de l’exportation sont précisés dans le corps.

curl -X POST -H 'X-API-TOKEN: yourapitokenhere' -H 'Content-Type: application/json' -d '{

     "surveyId": "SV_012345678912345",

     "format": "csv"

 }' 'https://yourdatacenterid.qualtrics.com/API/v3/responseexports'

Générer un jeton API

Un jeton API sera nécessaire pour accéder à l’API Qualtrics. Chaque utilisateur d’une licence doit générer son propre jeton API. Le jeton API de votre compte est requis pour authentifier chaque demande API que vous créez. Votre jeton est utilisé à la place du mot de passe de votre compte et contribue à renforcer la sécurité de votre travail. Pour vous authentifier, incluez votre jeton sous l’en-tête HTTPS X-API-TOKEN.

Astuce Qualtrics : pour générer un jeton, l’utilisateur doit disposer de l’autorisation d’accès à l’API pour son compte. Si votre organisation n’a pas accès à la fonctionnalité API Qualtrics, veuillez contacter votre Commercial Qualtrics pour plus d’informations.

Pour générer un jeton API

Cliquez sur l’icône des paramètres utilisateur dans le coin supérieur droit de votre compte.
Sélectionnez Paramètres du compte.
Cliquez sur ID Qualtrics dans la barre de navigation.
Dans la zone API, cliquez sur Générer un jeton.

Avertissement : ne cliquez pas sur Générer un jeton si vous disposez déjà d’un jeton. Votre jeton API n’a besoin d’être généré qu’une seule fois. Si vous générez un nouveau jeton et que des extensions existantes utilisent l’ancien jeton, ces extensions existantes seront interrompues. La génération d’un nouveau jeton est irréversible. Il n’est pas possible de récupérer les anciens jetons.

Création d’une clé secrète client

Cliquez sur l’icône des paramètres utilisateur dans le coin supérieur droit de votre compte Qualtrics.
Sélectionnez Paramètres du compte.
Accédez aux ID Qualtrics.
Sélectionnez Gestionnaire de clients OAuth.
Cliquez sur Créer client.
Saisissez un nom de client.
Si vous le souhaitez, saisissez une adresse e-mail de contact.
Pour Type d’attribution, sélectionnez Identifiants client.
Cliquez sur Créer client.
Notez l’ ID client et la clé secrète client et enregistrez-les dans un lieu sécurisé.

Attention : une fois que vous quittez cette fenêtre, la clé secrète client est irrécupérable. Si vous perdez ou oubliez votre clé secrète client, vous devrez répéter le processus ci-dessus pour en générer un nouveau.