Qualtrics Platform
Customer Journey Optimizer
XM Discover
Qualtrics Social Connect

Utilisation de la documentation de l’API Qualtrics

À propos de la documentation API

Notre page Documentation sur l’API Qualtrics détaille l’ensemble de notre documentation actuellement disponible.

Cette page vous explique comment parcourir notre documentation, en expliquant ce que chaque section aborde et ce qui est disponible.

Aperçu

Dans la vue d’ensemble de l’API, vous pouvez voir des informations sur l’API Qualtrics en général, ainsi que des informations sur la pagination (c’est-à-dire, si vous exécutez une demande Répertorier les contacts et que vous avez plus de 100 contacts, le résultat sera paginé et une URL nextPage sera fournie pour obtenir les 100 suivantes, cela s’applique à toutes les demandes de collecte).

Liste d’autorisation des serveurs Qualtrics

Voir Liste d’autorisation des serveurs Qualtrics.

URL de base et ID de centre de données

Cette sous-section vous montre comment trouver l’ID de centre de données que vous devrez inclure dans l’URL de base pour vos demandes d’API.

Recherche de vos ID Qualtrics

Cette sous-section vous indique où se trouvent les différents ID dont vous aurez besoin lors de l’exécution de demandes d’API. Pour les ID qui ne sont pas disponibles dans cette section, voir Localisation des ID Qualtrics en inspectant l’élément.

Authentification

La sous-section Authentification décrit les informations nécessaires pour authentifier vos demandes, ainsi que des suggestions pour protéger votre jeton API. Pour plus d’informations sur le processus d’authentification, voir Génération d’un jeton API.

Paramètres

La sous-section Paramètres couvre les différentes méthodes de transmission des paramètres en fonction de la méthode HTTP utilisée (GET, POST, PUT ou DELETE).

Réponses

La sous-section Réponses contient des exemples des différents codes de réponse HTTP qui peuvent être renvoyés lorsque vous exécutez une demande, ainsi que les motifs possibles pour chaque code de réponse. Notre API renvoie toujours les réponses au format JSON, sauf dans le cas de la demande d’exportation de réponse où le fichier peut être renvoyé dans n’importe quel format disponible.

Astuce Qualtrics : si vous ne voyez pas Réponses ou Mise à niveau à partir de versions précédentes comme options dans la documentation, veillez à sélectionner Afficher tout 7 en bas de la liste de la section API.

Utilisation des API Qualtrics

Cette section de la documentation contient des extraits de code en Python et Java pour vous aider à développer des workflows pour la gestion des enquêtes et des utilisateurs et pour l’obtention des résultats d’enquête.

Avertissement : des fonctionnalités de codage personnalisées sont fournies en l’état et peuvent nécessiter des connaissances en programmation pour l’implémentation. 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.

Référence

La section Référence contient des informations importantes sur les formats de date et d’heure acceptables, les codes de langue, les limites de demandes et les détails sur les abonnements aux événements. Les abonnements aux événements vous permettent d’envoyer des notifications à une URL de publication lorsqu’un événement se produit (par exemple, une réponse enregistrée).

Demandes

Pour aider à organiser la documentation et aider les utilisateurs à trouver les demandes API qu’ils recherchent, les demandes sont catégorisées comme suit :

Organisations
Divisions
Groupes
Utilisateurs
Enquêtes
Exporter les réponses à l’enquête
Réponses
Importations des réponses
Bibliothèque de messages
Bibliothèque d’images
Distributions
Contacts de la plate-forme Insights
Abonnements à des évènements
Répertoire XM (public cible)

Paramètres et options de demande

Chaque requête d’API a un nom, une brève description, une table qui répertorie les paramètres possibles, la réponse, un exemple de requête dans cURL et l’assistant “Try It Out”. Comprendre comment utiliser ces informations peut vous aider à rationaliser votre travail.

Nom, description et URL

Les trois premiers éléments répertoriés pour une requête API sont le verbe HTTP, le nom de la requête API et une brève description de la requête.

L’URL utilisé dans la requête (ou “définition”) sera répertorié à côté du verbe HTTP.

Notez la structure d’analyse descendante utilisée dans les URL. Par exemple :

La demande de listes de distribution de listes utilise l’URL suivante : https://yourdatacenterid.qualtrics.com/API/v3/mailinglists
Vous pouvez ensuite utiliser un ID retourné avec cette demande pour obtenir une liste de distribution spécifique en ajoutant l’ID à la fin de l’URL : https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId
Pour répertorier les contacts de cette liste de distribution, ajoutez les contacts à la fin : https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId/contacts
Pour obtenir un contact spécifique, vous pouvez ensuite utiliser un ID de contact retourné dans la demande précédente : https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId/contacts/:contactId

Liste des paramètres du corps

Pour chaque demande d’API, vous verrez un tableau répertoriant tous les paramètres de corps possibles pouvant être utilisés (certains seront facultatifs, d’autres seront obligatoires). Cette table contient les informations suivantes :

Chaque nom de paramètre
Les formats acceptés pour chaque paramètre
si le paramètre est requis ;
Brève description du paramètre

Attention : tous les noms et valeurs de paramètres sont sensibles à la casse.

Exemple de demande

L’exemple de requête fourni dans la documentation vous montre comment mettre en forme la requête dans cURL. Ces requêtes incluent l’URL racine et tous les paramètres requis de la table des paramètres.

Astuce Qualtrics : comme les ID sont uniquement des exemples et non des ID réels, les demandes dans les exemples ne fonctionneront pas réellement, mais vous pouvez simplement les remplacer par des ID de votre propre compte.

Exemple de réponse

Cette section fournit un exemple de ce que vous pouvez vous attendre à recevoir une fois votre demande d’API réussie. Par exemple, si vous utilisez la demande API Créer un utilisateur, votre réponse sera l’ID utilisateur de l’utilisateur nouvellement créé.

Terminer des demandes d’API sur le site API

Notre documentation API vous permet d’exécuter rapidement et facilement une demande d’API. (Notez que la plupart des demandes API requièrent des ID Qualtrics.)

Attention : Faites attention lorsque vous testez des API. Si vous saisissez le minimum d’informations requises pour exécuter un appel d’API, cette fenêtre modale complétera votre demande d’API. Les champs requis varient en fonction de l’appel d’API et seront répertoriés sur la page de l’appel.

Sélectionnez entre Clé API et OAuth 2.0.
Saisissez le jeton API de votre compte dans le champ Jeton API. (Ou les informations OAuth 2.0 correspondantes, si vous sélectionnez OAuth 2.0.)
Saisissez des paramètres supplémentaires, le cas échéant.
Cliquez sur Utilisateurs pour choisir un serveur sur lequel tester. Pour un test plus précis, vous souhaitez qu’il corresponde au centre de données de votre compte.
Cliquez sur Envoyer demande d’API pour tester l’appel d’API.

Astuce : pour savoir quelles valeurs sont acceptables pour chaque paramètre, reportez-vous au tableau des paramètres de la demande. Vous pouvez également vous référer à l’exemple cURL dans la documentation.

Une fois que vous avez saisi les valeurs nécessaires pour votre demande, l’édition de l’appel s’affiche sous “Réponse”.

Attention : certaines demandes ne fonctionnent pas avec cette fonction de test. Cela sera indiqué sur la page de la demande.

De nombreuses pages de ce site ont été traduites de l'anglais en traduction automatique. Chez Qualtrics, nous avons accompli notre devoir de diligence pour trouver les meilleures traductions automatiques possibles. Toutefois, le résultat ne peut pas être constamment parfait. Le texte original en anglais est considéré comme la version officielle, et toute discordance entre l'original et les traductions automatiques ne pourra être considérée comme juridiquement contraignante.