Aperçu général de l’intégration API

Sur cette page:

À propos de l’intégration API

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 de la Marque peut utiliser l’API Qualtrics pour automatiser le processus de création de comptes plutôt que de créer des centaines de comptes individuellement. De même, un utilisateur peut automatiser la création des listes de contacts plutôt que de les compiler et de les importer manuellement. Qualtrics propose également divers Guides de solutions API (EN) qui peuvent vous aider à déterminer comment utiliser au mieux l’API selon vos besoins.

Attention : la mise en place des intégrations API peut nécessiter des connaissances en programmation. Notre équipe de support n’offre pas d’assistance ou de consultation sur le codage personnalisé. Vous pouvez toujours essayer de demander à 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 comprennent la Plateforme d’enquête, Site Intercept et iQ Directory (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 :

Vous pouvez également trouver la documentation des versions précédentes de la Plateforme d’enquête API et de l’ancien programme d’API Public cible ci-dessous :

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.

À travers ces méthodes, l’API Qualtrics vous permet d’interagir avec des éléments du système Qualtrics et d’intégrer ces domaines à votre CRM.

Démarrage

Le système d’API Qualtrics actuel utilise une URL racine pour exécuter les demandes :

https://yourdatacenterid.qualtrics.com/API/

L’URL racine est la base de toute demande API. Veuillez noter que le protocole est https et qu’il est donc crypté pour assurer la protection de vos informations d’identification.

Vous pouvez trouver votre identifiant de serveur de données en vous connectant à votre compte et en regardant l’URL dans la barre d’adresse du navigateur. La partie précédant qualtrics.com est votre identifiant de serveur de données. Autrement, si vous n’utilisez pas l’identifiant de serveur de données correct, vous recevrez une notification dans la réponse HTTP lorsque vous exécuterez une demande API, indiquant l’identifiant de serveur de données que vous devriez plutôt utiliser. Dans l’exemple ci-dessous, le serveur de données est au1.
Spécification du serveur de données dans la demande d’appel API

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 aurez toujours besoin de 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 précisons 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. 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 HTTP X-API-JETON.

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

Pour générer un jeton API

  1. Cliquez sur la silhouette dans l’angle supérieur droit de votre compte.
  2. Sélectionnez Paramètres du compte.
  3. Cliquez sur ID Qualtrics dans la barre de navigation.
  4. Dans la case intitulée API, cliquez sur Générer un jeton.
Avertissement : ne cliquez pas sur Générer un jeton si vous en possédez déjà un. 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 intégrations existantes utilisent l’ancien jeton, ces intégrations existantes seront corrompues. La génération d’un nouveau jeton est irréversible. il n’est pas possible de récupérer les anciens jetons.

API OAuth

Attention : vous consultez des informations sur une fonctionnalité dont seuls les Administrateurs de marques ont accès.

OAuth 2.0 est un cadre proposé par l’IETF en 2012. Lorsque vous effectuez des appels API, vous générez un jeton. Parfois, vous souhaitez travailler avec des utilisateurs tiers, mais vous ne souhaitez pas leur communiquer vos informations de connexion ou ce jeton, car ils peuvent utiliser ce jeton ultérieurement pour accéder à votre API. Vous ne souhaitez pas non plus continuer à générer un nouveau jeton, car cela invaliderait les autres appels API que vous avez configurés.

Vous pouvez plutôt utiliser API OAuth pour générer temporairement quelque chose connu sous le nom de Secret client. Ce secret client sera « actualisé » après une heure, ce qui signifie qu’il ne fonctionnera plus.

SDK pour Application mobile

Afin que votre Projet de feedback sur applications mobiles (EN) fonctionne, il existe une intégration que vous devez mettre en place de votre côté. Le SDK pour Application mobile (Kit de développement logiciel) est disponible sur les pages suivantes :