Cas d’utilisation API courants

Sur cette page:

À propos des cas d’utilisation d’API

Cette page met en évidence les façons dont d’autres clients Qualtrics tirent parti de l’API Qualtrics. Vous trouverez ci-dessous une liste des demandes d’API courantes que nos clients utilisent et les cas d’utilisation associés à chaque demande.

Attention : la mise en œuvre des intégrations 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 vous adresser à notre communauté d’utilisateurs dédiés (EN). Si vous souhaitez en savoir plus sur nos services de codage personnalisés, veuillez contacter votre Commercial Qualtrics.

Méthodes courantes

Service Web

L’automatisation de la construction des demandes d’API est généralement effectuée par un spécialiste informatique de votre organisation, car ce processus nécessite la mise en œuvre d’un code personnalisé. Toutefois, dans certains cas, vous pouvez utiliser une enquête Qualtrics pour automatiser au lieu d’un code personnalisé. Les étapes ci-dessous montrent comment accomplir ce processus.

Astuce : Pour automatiser la construction des demandes d’API à partir de Qualtrics, vous devez vous familiariser avec la création d’une demande d’API (EN) et avec les services Web (EN). En outre, vous devrez inclure une question d’enquête qui recueille les informations personnelles nécessaires d’un participant (p. ex., une question de saisie de texte – Formulaire).

Suivez les étapes ci-dessous une fois que votre enquête a été construite :

  1. Accédez à l’onglet Enquête et ouvrez votre flux d’enquête.
    pour vous rendre au flux d’enquête et ajouter un élément de service Web
  2. Cliquez sur Ajouter ci-dessous ou Ajouter un nouvel élément ici.
  3. Sélectionnez Service Web.
  4. Insérez l’URL de la demande d’API dans la section Définition de la documentation.
    Menu Service Web
  5. Sélectionnez la méthode que vous souhaitez utiliser (c.-à-d. OBTENIR, METTRE, POSTER ou SUPPRIMER).
    Attention : Bien que CORRECTIF soit disponible dans l’élément Service Web, il ne peut pas être utilisé avec l’API Qualtrics.
  6. Cliquez sur Ajouter un en-tête personnalisé à envoyer au service Web.
  7. Saisissez JETON X-API dans le champ En-tête au service Web et votre jeton dans le champ Valeur.
    Saisir le jeton X-API dans le service Web
  8. Ajoutez tous les paramètres d’en-tête requis pour votre demande d’API en cliquant sur le signe plus (+).
  9. Si vous avez défini la méthode sur POSTER ou METTRE, cliquez sur Ajouter un paramètre de texte à envoyer au service Web et saisissez tous les paramètres et valeurs requis.
  10. Réglez la valeur de chaque paramètre à sa droite.
    Astuce : Vous voudrez utiliser du texte inséré (EN) pour les valeurs avec des données dynamiques, telles que Prénom, Nom et E-mail.

    Saisir le texte inséré pour les champs dynamiques dans le service Web

  11. Si vous utilisez l’API v2.x dans l’élément Service Web, vous devez ensuite cliquer sur Ajouter un paramètre de requête à envoyer au service Web pour ajouter les paramètres et valeurs d’URL des demandes.

JSON

Vous pouvez transmettre vos paramètres au format JSON via le texte de la demande. Lorsque vous utilisez cette méthode, vous devez préciser un type de contenu (c.-à-d. application/json ou texte/json). Cette méthode est généralement réalisée par un spécialiste informatique de votre organisation, car ce processus nécessite la mise en œuvre d’un code personnalisé.

Chaîne de requête

Attention : Veuillez noter que nos demandes d’API v3 ne peuvent pas être formatées en tant que chaînes de requête, car le jeton et d’autres paramètres doivent être transmis via les en-têtes et le corps de la demande. Vous pouvez transmettre vos paramètres de demande d’API via la syntaxe de chaîne de requête standard si vous utilisez l’API v2.x. Vous commencez par l’URL racine et ajoutez chacun de vos paramètres requis à la fin.

URL racine :

https://survey.qualtrics.com/WRAPI/ControlPanel/api.php

Pour le premier paramètre qui est ajouté à l’URL racine, incluez un « ? » suivi du nom du paramètre, d’un signe égal et de la valeur du paramètre (p. ex., ?Version=2.4). Ajoutez tous les paramètres ultérieurs avec une esperluette principale « & » (p. ex., &Request=importPanel).

URL racine + Paramètres requis :

https://survey.qualtrics.com/WRAPI/ControlPanel/api.php ?Version=2.4&Request=importPanel
&User=kathleenb_gen&Jeton=12345678901234567890&Format=XML

Continuez d’ajouter ou d’apposer d’autres paramètres supplémentaires à votre URL en suivant le même processus que celui décrit ci-dessus. Une fois que vous aurez inclus tous les paramètres souhaités, vous aurez une demande terminée.

URL racine + Paramètres requis + Paramètres supplémentaires :

https://survey.qualtrics.com/WRAPI/ControlPanel/api.php ?Version=2.4&Request=portPanel
&User=kathleenb_gen&Jeton=12345678901234567890&Format=XML
&LibraryID=UR_12345678901234567890&En-têtesdecolonne=1&Email=3&URL=https %3A %2F %2Fco1.qualtrics.com
 %2FWRQualtricsControlPanel %2FFile.php %3FF %3DF_3IeSPPh9HjXwaj3 %26téléchargement %3D1&Nom=Test
&FirstName=1&Nomdefamille=2&AllED=1

Vous trouverez des instructions détaillées concernant les chaînes de requête sur la page d’assistance Transmission d’informations par l’intermédiaire des chaînes de requête (EN).

Plateforme d’enquête

Automatisation de l’importation d’une liste de contacts

Vous pouvez utiliser la demande Créer des contacts Importer (EN) pour importer des lots de contacts dans votre compte Qualtrics. Grâce à cette demande, vous pouvez importer des listes JSON d’individus à partir de votre CRM dans Qualtrics. Ces contacts peuvent être importés soit en téléchargeant un fichier JSON et en définissant le paramètre d’en-tête Content-Type sur multipart/form-data, soit en incluant les contacts dans le texte de la demande et en définissant Content-Type sur application/json.

Automatisation de la création d’un contact

Plutôt que de manuellement mettre à jour les listes de contacts avec les nouveaux membres contact, vous pouvez automatiser le processus en utilisant la demande Créer un contact (EN). Cette demande ajoute un nouveau contact à une liste de contacts existante. Pour cette demande, vous aurez besoin de l’ID de la liste de distribution et de tous les autres champs que vous souhaitez ajouter au contact. Ceux-ci devront être transmis dans le texte de la demande, en définissant Content-Type sur application/json.

Générer vos propres liens individuels

Vous devrez peut-être distribuer votre enquête par un courrier interne plutôt que par le courrier Qualtrics. Avec l’API Qualtrics, vous pouvez construire des liens individuels (EN) qui suivent les informations personnelles d’un répondant sans avoir à utiliser l’e-mail Qualtrics.

Pour accomplir cette tâche, vous devez utiliser deux demandes d’API : Créer une distribution et des Liens de distribution (EN). Avant de commencer, vous devrez importer une liste de contacts dans Qualtrics manuellement ou en utilisant la demande API Créer une importation des contacts (EN).

Les paramètres d’intérêt pour la demande Créer une distribution et Liens de distribution sont :

  • ID de la liste de distribution (chaque distribution est liée à une liste de distribution)
  • ID d’enquête
  • Description (le nom de la distribution)
  • Action (la valeur ici doit être CreateDistribution)
Attention : Si une date d’expiration n’est pas spécifiée (il s’agit d’un paramètre facultatif), les liens expireront après 60 jours.

Automatiser le téléchargement de vos données en préparation de l’importation dans votre CRM

Si vous avez besoin de données provenant de nombreuses enquêtes au quotidien, vous pouvez utiliser notre API pour obtenir des réponses. L’API v3 utilise une série de trois demandes pour obtenir des données :

  • Créer une exportation de réponse (EN) : Cette demande démarre le processus d’exportation et est utilisée pour spécifier le format de fichier et d’autres préférences. Cela renverra un ID d’exportation de réponse.
  • Obtenir la progression de l’exportation de la réponse (EN) : Cette demande est utilisée pour vérifier la progression de l’exportation à l’aide de l’ID d’exportation de réponse fourni dans la première demande. Une fois que percentComplete atteint 100, vous pouvez utiliser la dernière demande pour obtenir le fichier.
  • Obtenir le fichier d’exportation des réponses (EN) : Une fois le fichier prêt, vous pouvez utiliser cette demande pour le télécharger. Il sera exporté sous forme de fichier compressé. Veuillez noter que bien que la plupart des demandes d’API fonctionnent lorsque l’ID de centre de données n’est pas correct dans l’URL, cette demande ne fonctionnera pas. Veuillez vous assurer d’utiliser l’ID de centre de données correct dans cette demande.

Cette séquence de demandes télécharge vos données brutes, ce qui vous permet d’obtenir plus facilement vos données, puis d’importer ces réponses dans votre CRM, votre entrepôt de données, etc.

XM Directory

Mise à jour d’un contact (Liste des contacts du répertoire et Mise à jour d’un contact du répertoire)

Parfois, vous pouvez souhaiter mettre à jour un contact via l’API. Pour ce faire, vous aurez besoin de l’ID de contact du contact. La demande d’API Liste des contacts du répertoire (EN) vous permet de rechercher l’ID de contact d’un contact, que vous pouvez ensuite utiliser pour les demandes d’API ultérieures. Nous allons d’abord expliquer la demande d’API Liste des contacts du répertoire (EN), puis Mise à jour d’un contact du répertoire (EN).

Tout ce dont vous aurez besoin pour la demande Liste des contacts du répertoire (EN) est l’ID de répertoire. Le résultat de la requête Liste des contacts du répertoire (EN) consistera à recevoir l’ID de contact du contact afin que vous puissiez l’utiliser pour des demandes telles que Mise à jour d’un contact du répertoire (EN).

Il existe ensuite deux paramètres principaux d’intérêt pour la demande Mise à jour d’un contact du répertoire (EN) : ID de répertoire et ID de contact. Suite à la demande Mise à jour d’un contact du répertoire (EN), le contact spécifié sera mis à jour avec les informations que vous avez modifiées en fonction des paramètres de votre demande.

Guides de solution API

Vous trouverez divers guides de solutions pour la gestion des enquêtes, la gestion des utilisateurs (EN), la gestion des groupes d’utilisateurs (EN) et l’Obtention de réponses à l’enquête (EN) sur notre site Web de documentation sur l’API v3 (EN).