Produits pris en charge
Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing HubPro
Sales HubSales HubPro
Service HubService HubPro
Content HubContent HubPro
Dernière modification : 22 août 2025
Utilisez l’API d’identification des visiteurs pour identifier les visiteurs de votre site qui ont été authentifiés à l’aide de votre propre système d’authentification externe. Un jeton d’identification renvoyé par cette API peut être utilisé pour transmettre des informations sur votre visiteur déjà authentifié au widget de chat, afin qu’il le traite comme un contact connu. Les agents de la boîte de réception peuvent alors savoir avec certitude à qui ils parlent et les visiteurs peuvent accéder à l’historique des discussions précédentes sur tous les appareils. Si vous hébergez votre propre application web derrière une connexion, vous pouvez configurer le widget de chat HubSpot pour qu’il apparaisse sur les pages de votre application web où vous savez que les visiteurs ont déjà été authentifiés et identifiés. Actuellement, tout visiteur discutant sur ces pages apparaît comme un visiteur inconnu dans la boîte de réception des conversations, bien qu’il soit identifié et connecté dans votre application web. Grâce à l’API d’identification des visiteurs, vous pouvez transmettre directement les informations relatives aux visiteurs authentifiés au widget de chat, qui les identifie dans la boîte de réception des conversations.

Remarque:

  • L’API d’identification des visiteurs permet d’indiquer à HubSpot qui est le visiteur. Vous ne devez pas vous appuyer sur ce système pour authentifier les utilisateurs de votre plateforme.
  • L’accès à l’API d’identification des visiteurs nécessite un abonnement Pro ou Entreprise. Si le compte n’a pas d’abonnement adéquat, vous recevrez une réponse d’erreur 403 de la part de l’API.

Exemple de flux d’intégration

Afin d’intégrer cette fonctionnalité, vous devez avoir une application web existante avec un système d’authentification. Avant de commencer, assurez-vous que vous disposez d’une application privée configurée et que le compte que vous essayez d’intégrer dispose d’un abonnement Pro ou Entreprise éligible. Voici un exemple de flux d’intégration possible :
Flux d'identification d'utilisateur possible
Une fois que votre client est connecté et vérifié dans votre système, suivez les étapes suivantes pour les identifier dans le chat en direct : 1. En front-end, définissez loadImmediately sur false dans l’objet hsConversationsSettings de la fenêtre. Autrement, le widget de chat pourrait se charger avant que les informations d’identification ne soient transmises. Reportez-vous aux principes du kit de développement logiciel pour le widget de chat ci-dessous pour plus d’informations.
  • Définissez les propriétés de hsConversationsSettings en dehors de la fonction isConversationsAPIReady.
  • En outre, hsConversationsSettings doit être défini avant l’appel. Autrement, vous risquez d’être confronté à une condition de course qui interfère avec le chargement des widgets.
window.hsConversationsSettings = {
  loadImmediately: false,
};
2. Générez un jeton à partir de l’API d’identification des visiteurs, en transmettant l’adresse e-mail de votre visiteur authentifié. Cela doit être fait en back-end de votre application web. Consultez la documentation de référence sur les points de terminaison pour obtenir un exemple de requête.
curl --request POST \
  --url 'https://api.hubspot.com/conversations/v3/visitor-identification/tokens/create \
--data '{
  "email": "gob@bluth.com",
  "firstName": "Gob",
  "lastName": "Bluth"
}'
Le prénom et le nom de famille fournis seront placés sur la fiche d’informations du contact dans HubSpot après le début du chat si :
  • Il s’agit d’un nouveau contact créé par l’API d’identification des visiteurs ;
  • Il s’agit d’un contact existant dont le nom n’est pas encore connu.
Cela peut être utile lors de la personnalisation des messages pour les visiteurs identifiés lorsque votre système externe dispose déjà d’informations sur le nom, mais qu’il n’existe pas encore dans HubSpot. Il s’agit de paramètres facultatifs et non obligatoires.
3. En utilisant le jeton de l’étape 2, définissez les propriétés suivantes sur l’objet hsConversationsSettings de la fenêtre.
window.hsConversationsSettings = {
  identificationEmail: 'visitor-email@example.com',
  identificationToken: '<TOKEN FROM STEP 1>',
};
4. Chargez le widget.
window.HubSpotConversations.widget.load();
Le jeton et l’e-mail doivent être définis dans l’objet hsConversationsSettings de la fenêtre chaque fois que la page est chargée pour un visiteur authentifié. Ce contexte ne sera pas automatiquement répercuté sur les chargements de page si ces paramètres ne sont plus définis. Les jetons sont temporaires et expireront au bout de 12 heures. Les jetons peuvent être mis en cache pour éviter de récupérer le jeton à chaque chargement de page, tant qu’ils sont actualisés au moins toutes les 12 heures.

Vérifier l’intégration

Une fois votre intégration de la fonction d’identification des visiteurs terminée, vous pouvez vérifier son bon fonctionnement. Cela peut être fait de plusieurs façons, en fonction de votre mise en œuvre. Ainsi, vous devrez peut-être adapter les exemples ci-dessous selon vos exigences spécifiques.
  • Si vous avez ajouté le widget de chat sur une ou plusieurs pages publiques ainsi que derrière un système d’authentification :
    • Accédez à une page où le widget de chat ne doit pas identifier les visiteurs et lancez une conversation.
    • Dans HubSpot, ouvrez la boîte de réception et vérifiez que le chat qui vient d’arriver appartient à un visiteur inconnu. Si ce n’est pas le cas, essayez de suivre ces étapes dans une fenêtre de navigation privée :
      • Accédez à une page où le widget de chat doit identifier les visiteurs via l’API d’identification des visiteurs et lancez une conversation.
      • Dans HubSpot, ouvrez la boîte de réception et vérifiez que le chat est correctement attribué au contact sous lequel vous êtes connecté. Vous devriez voir un badge à côté du nom du contact indiquant que ce contact a été identifié avec succès via cette API.
visitor_identity_badge
  • Si vous avez ajouté le widget de chat uniquement sur les pages derrière un système d’authentification et que vous avez accès à plusieurs comptes de test :
    • Connectez-vous à HubSpot en tant que premier utilisateur test, puis accédez à une page où le widget de chat se charge et lancez une conversation.
    • Déconnectez-vous de HubSpot et reconnectez-vous en tant que deuxième utilisateur. Accédez à une page où le widget de chat se charge et démarrez une conversation.
    • Dans HubSpot, ouvrez la boîte de réception et vérifiez que les conversations entrantes provenaient respectivement des premier et deuxième comptes de test, et que vous voyez le badge à côté des noms de contact pour les deux fiches d’informations.

Remarque:

pour les visiteurs identifiés avec cette API, HubSpot ne déconnectera pas le cookie messagesUtk. HubSpot ignorera également toutes les questions de collecte d’adresse e-mail car celle-ci est déjà connue. Comme le cookie messagesUtk et la collecte d’adresse e-mail ne s’appliquent pas à ces chats, les paramètres associés dans le chatflow ne s’afficheront pas pour les visiteurs identifiés via l’API d’identification des visiteurs.

Principes du kit de développement logiciel pour le widget de chat

L’API est hébergée dans l’objet window.HubSpotConversations. Toutes les méthodes disponibles peuvent être consultées via cet objet. Le chargeur de scripts HubSpot sur votre page créera cet objet pour vous, mais il ne pourra pas être immédiatement disponible. Pour reporter l’accès à l’API jusqu’à son initialisation, vous pouvez utiliser l’assistant window.hsConversationsOnReady. Par exemple :
<script type="text/javascript">
  function onConversationsAPIReady() {
    console.log(`HubSpot Conversations API: ${window.HubSpotConversations}`);
  }
  /*
    configure window.hsConversationsSettings if needed.
  */
  window.hsConversationsSettings = {};
  /*
   If external API methods are already available, use them.
  */
  if (window.HubSpotConversations) {
    onConversationsAPIReady();
  } else {
    /*
      Otherwise, callbacks can be added to the hsConversationsOnReady on the window object.
      These callbacks will be called once the external API has been initialized.
    */
    window.hsConversationsOnReady = [onConversationsAPIReady];
  }
</script>

Référence pour le kit de développement logiciel

Tableau window.hsConversationsOnReady Il s’agit d’un champ facultatif que vous pouvez définir sur l’objet de la fenêtre qui vous permet de spécifier le code à exécuter dès que le widget est disponible. Une fois que l’API a été initialisée, elle vérifiera l’existence de ce tableau et exécutera ses fonctions en série.
if (window.HubSpotConversations) {
  console.log('The api is ready already');
} else {
  window.hsConversationsOnReady = [
    () => {
      console.log('Now the api is ready');
    },
  ];
}
Objet hsConversationsSettings Cet objet vous permet de fournir des options de configuration au widget avant son initialisation. Pour utiliser la fonction d’identification des visiteurs, vous devez définir les champs suivants :
ParamètreTypeDescriptionDéfaut
loadImmediatelybooléenSi le widget doit se charger implicitement ou attendre que la méthode widget.load soit appelée.true
identificationTokenchaîneUtilisé pour intégrer l’API d’identification des visiteurs. Il s’agit du jeton fourni par le point de terminaison de génération de jeton sur l’API d’identification des visiteurs qui est utilisé comme preuve que ce visiteur a été identifié.""
identificationEmailchaîneL’adresse e-mail du visiteur que vous avez identifié comme chargeant le widget.""
window.hsConversationsSettings = {
  loadImmediately: false,
  identificationEmail: 'visitor-email@example.com',
  identificationToken: '<TOKEN FROM STEP 1>',
};
Découvrez-en davantage sur le kit de développement logiciel pour les conversations.