Modèle d’article

Général

Comment activer mon Compte développeur ?

Pour accéder à l’API et aux fonctions connexes, vous devez d’abord activer le compte de développeur. Voir Informations personnelles Préférences pour plus d’informations.

Comment commencer à utiliser l’API Social Connect ?

Consultez le guide étape par étape de l’API Qualtrics Social Connect.

De quel type de compte ai-je besoin pour utiliser l’API Social Connect ?

L’accessibilité à l’API n’est pas incluse dans tous les plans tarifaires. Contactez le support si vous avez des questions sur ce qui est inclus dans votre licence.

Disposez-vous d’une bibliothèque de clients dans le langage de programmation x ?

Qualtrics ne propose pas de bibliothèques client, mais des bibliothèques pour le protocole OAuth existent dans presque toutes les langues, voir http://oauth.net/code/.

Puis-je tester rapidement l’API ?

Vous pouvez tester l’API via la console API. Ici, vous choisirez un point de terminaison et remplirez les paramètres requis. Un résultat immédiat s’affichera pour vous permettre de voir si l’API a abouti au résultat souhaité.

Pouvez-vous augmenter les limites de débit de l’API ?

Voir Limitation du débit pour une vue d’ensemble des limites de débit de l’API. Nos limites de taux actuelles sont plus que suffisantes pour les cas d’utilisation standard. Si toutefois vous avez besoin de limites tarifaires supplémentaires, veuillez contacter le support et décrire le cas d’utilisation de votre application et les limites tarifaires demandées.

Comment fonctionne le filtrage dans l’API ?

Plusieurs points de terminaison de l’API Social Connect vous permettent de passer un paramètre de chaîne de filtre.

Par exemple, supposons que vous récupériez une liste de mentions. Vous pouvez filtrer les mentions de manière à ce que seules les mentions avec une certaine étiquette soient renvoyées.

Le paramètre Filtre est toujours une chaîne de caractères. Sa syntaxe permet de rechercher plusieurs propriétés des données (mots mentionnés, tags, statut, temps de résolution, …) et de les combiner à l’aide d’une syntaxe booléenne et imbriquée.

Lorsque vous créez un filtre dans la plateforme Social Connect, celui-ci est associé à une représentation textuelle. Cette représentation apparaîtra dans la fenêtre de filtre une fois que vous aurez sélectionné vos champs de filtre. Vous pouvez copier ce paramètre pour l’utiliser ensuite dans vos appels à l’API.

Quelle est la méthode utilisée pour signer les webhooks ?

Voir Webhooks pour plus d’informations.

Pourquoi mon taux est-il limité à 20 appels API par heure ?

Si vous utilisez la console API, la limite de débit est de 20 appels authentificateurs par heure, au lieu des 350 appels par heure standard pour les autres clients API. Si vous rencontrez cette limite de 20 appels, assurez-vous que vous utilisez la clé d’accès pour votre application API, et non pour la console API.

Authentificateur API

Comment les appels à l’API sont-ils authentifiés ?

Qualtrics utilise le protocole standard OAuth 2.0. Voir Authentificateur pour plus d’informations.

Dois-je vraiment mettre en œuvre OAuth pour mon application ?

Si vous n’avez pas besoin que les utilisateurs de votre application authentifient leur compte Qualtrics Social Connect, vous pouvez à la place générer un jeton OAuth pour votre propre compte utilisateur. Allez dans l’aperçu de l’application, cliquez sur Modifier à côté de votre application enregistrée, allez dans l’onglet Jetons d’accès. Si vous cliquez sur Autoriser moi-même, un jeton d’accès pour votre utilisateur connecté actuel (avec ses autorisations) sera généré. Vous pouvez utiliser cette clé d’accès pour signer les demandes d’API.

Quelle est la durée de validité des jetons d’accès ?

Voir la page Authentificateur pour plus d’informations.

À quels comptes et données puis-je accéder avec un token ?

Un jeton d’accès OAuth est généré pour un utilisateur spécifique de Social Connect. Cet utilisateur a accès à un ou plusieurs comptes (vous pouvez voir lesquels via le point de terminaison `/me/accounts`). Les données auxquelles vous pouvez accéder dépendent des comptes auxquels l’utilisateur lui-même a accès et de son rôle dans ce compte.

Travailler avec des mentions

Comment intégrer les mentions de ma boîte de réception Social Connect dans ma propre application ?

Utilisez le point de terminaison `/{account_id}/inbox/mentions` pour récupérer toutes les mentions dans n’importe lequel de vos sujets. Cette page d’assistance de l’API couvre les informations récupérées pour vos mentions.

Vous pouvez également concevoir un flux de travail pour appeler des crochets web dans votre application à l’aide de la fonction de recette d’automatisation de Social Connect.

Pourquoi les tweets renvoyés par l’API manquent-ils de détails ?

Pour les tweets, Qualtrics ne peut renvoyer que les données spécifiques à Social Connect et l’identifiant du tweet de Twitter. Il s’agit d’une restriction des conditions d’utilisation de l’API de Twitter.

Puisque vous avez l’ID du Tweet, vous pouvez accéder à l’API de Twitter et utiliser le point de terminaison “/statuses/lookup” pour récupérer tous les détails.

Pourquoi certaines publications sur Facebook sont-elles anonymes ?

Les publications publiques sur Facebook (récupérées par Social Connect par le biais de votre recherche par mot-clé, et non les messages sur vos pages Facebook) sont anonymes. Il s’agit d’une limitation de l’API de Facebook.

Puis-je ajouter mes propres messages à Social Connect ?

Si vous disposez d’un formulaire de contact ou d’un forum interne que vous souhaitez voir suivi par Social Connect, vous pouvez appeler le point de terminaison “/{account_id}/inbox/add” pour ajouter vos messages personnalisés à Social Connect. Ces messages seront alors accessibles dans votre boîte de réception et dans vos aperçus.

Les messages ajoutés à Social Connect via l’API ne peuvent pas faire l’objet d’une réponse à partir de Social Connect Si vous souhaitez bénéficier de cette intégration plus étroite avec votre système personnalisé, veuillez contacter l’assistance.

Puis-je exporter des cas via l’API ?

Vous pouvez utiliser le point d’arrivée des mentions régulières (exporter la liste / mettre à jour une seule mention) pour exporter des cas. Si vous ne souhaitez renvoyer que les cas dans votre requête, vous pouvez utiliser le filtre ‘sub_category:case’.

Quelle est la différence entre les cas et les mentions pour l’API ?

Dans Social Connect, une “mention” est l’objet central d’un message (un seul tweet, un seul message privé, un seul commentaire). Il existe également le concept de “cas”, qui est en fait un ensemble de mentions.

L’utilisation principale des cas est de regrouper plusieurs messages d’un certain utilisateur et des réponses d’agents dans des conversations.

D’un point de vue technique, une “conversation sur un cas” consiste à

• L’étui lui-même (qui est également un objet de mention).
• Un dossier peut avoir des étiquettes, un statut, un titre, etc.
• Une liste des mentions qui font partie de la conversation.
• Les mentions qui ont été regroupées dans le dossier.

Consultez cette page d’assistance de l’API pour plus d’informations sur les cas et les mentions.

Puis-je importer des messages dans la boîte d’envoi de Social Connect ?

Vous pouvez créer des brouillons de nouveaux messages que les managers sociaux pourront vérifier, modifier et publier via le point de terminaison “/{account_id}/publisher/add”.

Puis-je modifier une mention via l’API ?

Vous pouvez modifier les mentions existantes en utilisant le point de terminaison “/{account_id}/inbox/mention/{topic_id}/{id}”. La documentation de ce point d’accès contient des exemples de mise à jour des balises d’une mention, d’ajout d’une note, etc.

Comment supprimer toutes les données d’un certain utilisateur dans Engage via l’API ?

Si vous souhaitez supprimer toutes les données d’un certain client qui se trouvent dans votre compte Social Connect, vous devez supprimer deux types de données :

1. Toutes les mentions de cet utilisateur dans le système
2. Toutes les informations relatives à cet utilisateur qui sont stockées dans le CRM de Social Connect.

Pour trouver toutes les mentions d’un certain utilisateur, utilisez le point de terminaison “/{account_id}/inbox/mentions” et filtrez pour un certain authorID, par exemple “author.id:123”. Une fois que vous avez cette liste de mentions, les mentions peuvent être supprimées via le point de terminaison “/{account_id}/inbox/mention/{topic_id}/{id}”.

Pour savoir si vos agents ont enregistré d’autres données de contact dans le CRM de Social Connect pour un contact, effectuez une requête GET à “/{account_id}/inbox/contact/{service}/{service_id}”. Si l’objet de la réponse contient un contact.id, cela signifie qu’il existe un contact pour cet utilisateur. Si la réponse ne contient pas de propriété contact.id, cela signifie qu’aucune information n’a été stockée dans le CRM Social Connect.

Une fois que vous avez un contact.id, vous pouvez effectuer une requête DELETE vers le point de terminaison /{account_id}/inbox/contact/{contact_id} pour supprimer toutes les informations.

Travailler avec des contacts ​

Comment trouver les coordonnées d’une personne à partir d’une mention ou d’un dossier ?

Si une mention ou un cas est renvoyé par l’API, il contiendra une liste d’objets “action_link”. Les liens d’action contiennent des informations pour l’objet actuel sur les autres points de terminaison API ou URL de l’application web qui sont pertinents pour cet objet. Pour les mentions et les cas, l’un des liens d’action inclus permet d’obtenir les coordonnées de l’auteur de la mention ou du cas.

Lors de l’utilisation du point de terminaison /{account_id}/inbox/cases, l’objet de contact de l’auteur de la mention est inclus par défaut. Qualtrics n’inclut pas l’objet de contact complet pour les mentions, mais via les liens d’action, cet objet peut être récupéré en effectuant un appel API séparé.

Publier

Puis-je utiliser l’API Clarabridge Engage pour publier sur un canal social ?

Non, l’API ne permet pas de publier directement sur des plateformes tierces. Cela signifie que vous ne pouvez pas utiliser l’API Social Connect pour publier un tweet ou un commentaire sur Facebook.

Toutefois, vous pouvez utiliser l’API de Social Connect pour créer des brouillons ou mettre des messages en file d’attente pour approbation. Celles-ci seront ensuite publiées une fois approuvées ou publiées via l’interface Social Connect. Le point de terminaison pour la rédaction des messages est /{account_id}/publisher/add.

Manager les utilisateurs

Puis-je modifier le statut des utilisateurs via l’API ?

Non, vous ne pouvez pas modifier le statut des utilisateurs via l’API. Vous ne pouvez pas modifier le statut, mais vous pouvez modifier le nom, la société, l’adresse électronique, l’avatar et l’horaire des heures ouvrables via le point de terminaison /{account_id}/settings/user/{id}.

Puis-je modifier le rôle des utilisateurs via l’API ?

Il est possible de modifier le rôle d’un utilisateur via notre API. Cependant, pour des raisons de sécurité, il n’est pas possible de changer le rôle d’un utilisateur en Administrateur. Tous les autres rôles d’utilisateur peuvent être modifiés via le point de terminaison /{account_id}/settings/user/{id}.

Puis-je créer de nouveaux utilisateurs via l’API ?

Pour des raisons de sécurité, cela n’est pas possible via l’API.

Travailler avec des profils sociaux

Puis-je récupérer des informations sur les profils sociaux dans mes thèmes ?

Vous pouvez obtenir des informations sur un certain profil social via le point de terminaison “/{account_id}/inbox/contact/{service}/{service_id}”. Cela inclut tous les détails que vous avez renseignés pour cette personne dans le CRM de Social Connect, comme le sexe, l’adresse électronique ou les attributs personnalisés que vous avez ajoutés pour cet utilisateur.

Travailler avec Insights

Puis-je obtenir des statistiques de Clarabridge Engage ?

Vous pouvez extraire des données d’Insights à l’aide de deux points d’extrémité d’API différents ;

1. Le point de terminaison “/{account_id}/dashboards/export/{dashboard_id}” renvoie les données de tous les widgets d’un tableau de bord donné. Une fois que vous ou vos utilisateurs avez mis en place des tableaux de bord personnalisés, vous pouvez utiliser ce point d’accès pour obtenir les données qui les sous-tendent.
2. Le point de terminaison “/{account_id}/insights/facets” est l’équivalent dans l’API de la fonction Chart Builder de Social Connect.

Problèmes

Où puis-je trouver l’identifiant de mon compte ?

Une fois authentifié, vous pouvez obtenir une liste de tous les comptes (et de leurs identifiants) auxquels un utilisateur a accès via le point de terminaison “/me/accounts”.

Où puis-je trouver mon numéro d’identification ?

Une fois authentifié, vous pouvez obtenir une liste de tous les sujets (et de leurs identifiants) auxquels un utilisateur a accès via le point de terminaison “/me/accounts”.

Où puis-je trouver mon identifiant ?

Une fois que vous vous êtes authentifié, vous pouvez obtenir des détails sur l’utilisateur authentificateur (y compris son identifiant) via le point de terminaison “/me”.