FAQ sur les API de Social Connect

Général

Comment activer mon compte développeur ?

Pour accéder à l’API et aux fonctionnalités associées, vous devez d’abord activer le compte développeur. Pour plus d’informations, voir Préférences des options personnelles.

Comment démarrer avec l’API Social Connect ?

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

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

L’accès à l’API n’est pas inclus dans tous les plans tarifaires. Contactez l’assistance si vous avez des questions sur ce qui est inclus dans votre licence.

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

Qualtrics ne propose pas de bibliothèques client, mais les 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 allez sélectionner un point d’extrémité et renseigner les paramètres requis. Un résultat immédiat s’affiche pour vous permettre de voir si l’API a donné le résultat souhaité.

Pouvez-vous augmenter les limites de taux d’API ?

Voir Limitation des tarifs pour obtenir une synthèse des limites de tarif API. Nos limites de taux actuelles sont plus que suffisantes pour les cas d’utilisation standard. Si toutefois vous avez besoin de limites de tarifs supplémentaires, veuillez contacter le service d’assistance et décrire le cas d’utilisation de votre application et les limites de tarifs demandées.

Comment fonctionne le filtrage dans l’API ?

Plusieurs points d’extrémité de l’API Social Connect vous permettent de transmettre un paramètre de chaîne de filtre.

Par exemple, supposons que vous recherchiez une liste de mentions. Vous pouvez filtrer les mentions de sorte que seules les mentions avec une balise donnée soient renvoyées.

Le paramètre de filtre est toujours une chaîne. Sa syntaxe prend en charge la recherche de plusieurs propriétés des données (mots mentionnés, balises, statut, heure de résolution, etc.) et leur combinaison à l’aide d’une syntaxe booléenne et imbriquée.

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

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

Voir Webhooks pour plus d’informations.

Pourquoi suis-je limité à 20 appels API par heure ?

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

Authentification API

Comment les appels API sont-ils authentifiés ?

Qualtrics utilise le protocole OAuth 2.0 standard. Pour plus d’informations, voir Authentification.

Dois-je vraiment implémenter OAuth pour mon application ?

Si vous n’avez pas besoin que les utilisateurs de votre application authentifient leur compte Qualtrics Social Connect, vous pouvez plutôt générer un jeton OAuth pour votre propre compte utilisateur. Accédez à la synthèse de l’application, cliquez sur Modifier en regard de votre application enregistrée, accédez à l’onglet Jetons d’accès. Si vous cliquez sur M’autoriser, un jeton d’accès pour votre utilisateur connecté actuel (avec ses autorisations) sera généré. Vous pouvez utiliser ce jeton d’accès pour signer des demandes d’API.

Combien de temps les jetons d’accès sont-ils valides ?

Pour en savoir plus, voir la page Authentification.

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

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/comptes »). Les données auxquelles vous pouvez accéder dépendent des comptes auxquels l’utilisateur a lui-même accès et de son rôle dans ce compte.

Utilisation des mentions

Comment obtenir des 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 l’un 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 d’opérations pour appeler des Webhooks dans votre application à l’aide de la fonctionnalité de recette d’automatisation Social Connect.

Pourquoi les Tweets retournés par l’API manquent-ils de détails ?

Pour les Tweets, Qualtrics peut uniquement renvoyer les données spécifiques à Social Connect et l’identifiant du Tweet Twitter. Il s’agit d’une restriction des conditions de l’API Twitter.

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

Pourquoi certaines publications Facebook sont-elles anonymes ?

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

Puis-je ajouter mes propres messages à Social Connect ?

Si vous avez un formulaire de contact ou un forum interne que vous souhaitez voir surveillé 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 ensuite accessibles dans votre boîte de réception et dans vos analyses.

Les messages ajoutés à Social Connect via l’API ne peuvent pas être répondus à partir de Social Connect Si vous souhaitez avoir cette intégration plus étroite avec votre système personnalisé, veuillez contacter le support.

Puis-je exporter des cas via l’API ?

Vous pouvez utiliser le point de terminaison de mention standard (liste d’exportation/mise à jour de mention unique) pour exporter des cas. Si vous voulez uniquement retourner des cas dans votre demande, 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 y a aussi le concept de « cas » qui est essentiellement une collection de mentions.

L’utilisation principale des cas consiste à regrouper plusieurs messages d’un utilisateur donné et les réponses des agents dans des conversations.

D’un point de vue technique, une « conversation de cas » consiste à :

• Le cas lui-même (qui est également un objet de mention).
• Une casse peut avoir des étiquettes, un statut, un titre, etc.
• Liste des mentions qui font partie de la conversation.
• Les mentions qui ont été regroupées dans l’affaire.

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

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

Vous pouvez créer des versions préliminaires de nouvelles publications pour les responsables sociaux afin de les vérifier, les modifier et les publier via le point de terminaison “/{account_id}/éditeur/add”.

Puis-je modifier une mention via l’API ?

Vous pouvez modifier les mentions existantes à l’aide du point de terminaison “/{account_id}/inbox/mention/{topic_id}/{id}”. La documentation de ce point de terminaison 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 voulez supprimer toutes les données d’un client donné qui se trouve 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. Toute information relative à cet utilisateur stockée dans Social Connect CRM.

Pour rechercher toutes les mentions d’un utilisateur donné, utilisez le point de terminaison “/{account_id}/inbox/mentions” et filtrez un ID d’autorisation donné, par ex. “author.id:123”.Une fois que vous disposez de 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 sauvegardé d’autres données de contact dans Social Connect CRM pour un contact, effectuez une demande GET à “/{account_id}/inbox/contact/{service}/{service_id}”. Si l’objet 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 donnée n’a été stockée dans Social Connect CRM.

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

Travailler avec des contacts  ​

Comment puis-je trouver les coordonnées d’une mention ou d’un cas ?

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 d’API ou URL dans l’application Web qui sont pertinents pour cet objet. Pour les mentions et les cas, l’un des liens d’action inclus vous permet de récupérer les coordonnées de l’auteur de la mention ou du cas.

Lorsque vous utilisez le 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 ensuite être extrait en effectuant un appel d’API distinct.

Publication en cours

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

Non, l’API n’autorise pas la publication directe sur des plateformes tierces. Cela signifie que vous ne pouvez pas utiliser l’API Social Connect pour publier un tweet ou un commentaire Facebook.

Cependant, vous pouvez utiliser l’API Social Connect pour créer des versions préliminaires ou des messages de file d’attente pour approbation. Celles-ci seront ensuite publiées lorsqu’elles seront approuvées ou publiées via l’interface Social Connect. Le point de terminaison des brouillons de messages est /{account_id}/éditeur/add.

Gestion des utilisateurs

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

Non, vous ne pouvez pas modifier le statut des utilisateurs via l’API. Bien que vous ne puissiez pas modifier le statut, vous pouvez modifier le nom, la société, l’e-mail, l’avatar et l’horaire de travail via le point de terminaison /{account_id}/settings/user/{id}.

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

Il est possible de modifier le rôle utilisateur d’un utilisateur via notre API. Cependant, pour des raisons de sécurité, il n’est pas possible de remplacer un rôle utilisateur par Administrateur. Tous les autres rôles utilisateur peuvent être modifiés en 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.

Utilisation des profils sociaux

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

Vous pouvez récupérer 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 Social Connect, tels que le sexe, l’e-mail ou les attributs personnalisés que vous avez ajoutés pour cet utilisateur.

Utilisation des analyses

Puis-je obtenir des statistiques de Clarabridge Engage?

Vous pouvez extraire des données depuis Insights à l’aide de deux points de terminaison 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 configuré des tableaux de bord personnalisés, vous pouvez utiliser ce point de terminaison pour obtenir les données sous-jacentes.
2. Le point d’extrémité “/{account_id}/insights/facettes” agit comme l’équivalent API de la fonctionnalité Générateur de graphiques dans Social Connect.

Problèmes

Où puis-je trouver mon identifiant de compte ?

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

Où puis-je trouver mon identifiant de sujet ?

Une fois que vous vous êtes authentifié, vous pouvez obtenir une liste de toutes les rubriques (et de leurs ID) auxquelles un utilisateur a accès via le point de terminaison “/me/account”.

Où puis-je trouver mon ID utilisateur ?

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