Migrer vers la V3

Le 1er août 2023, nous avons lancé Hyvor Talk V3, une refonte complète de notre système de commentaires basée sur les Web Components.

Calendrier

  • 2023-08-01 : lancement de la V3.
  • 2024-01-01 : la V2 est dépréciée et ne reçoit plus de mises à jour.
  • 2024-08-01 : les embeds et API de la V2 ne sont plus pris en charge. Le code V2 essaiera de charger la V3 automatiquement.

Est-ce que j'utilise la V2 ?

Si vous ne savez pas si vous utilisez la V2 ou la V3, vous pouvez vérifier le code de votre site web. Si vous avez un code similaire à celui-ci, vous utilisez la V2 :

<div id="hyvor-talk-view"></div>
<script type="text/javascript">
	var HYVOR_TALK_WEBSITE = YOUR_WEBSITE_ID;
	var HYVOR_TALK_CONFIG = {
		url: false,
		id: false
	};
</script>
<script async type="text/javascript" src="//talk.hyvor.com/web-api/embed"></script>

Vous pouvez aussi vérifier le code source dans l'inspecteur du navigateur. Si vous voyez une balise <iframe>, vous utilisez la V2.

Migration automatique

À partir du 1er août 2024, le script V2 a commencé à charger automatiquement la V3. Cela permet d'éviter que votre site web ne cesse de fonctionner. Cependant, il peut arriver que la migration automatique ne fonctionne pas.

Si le code V2 est toujours présent sur votre site web, nous vous recommandons vivement de migrer manuellement vers la V3 pour garantir les meilleures performances et la meilleure compatibilité.

Comment mettre à jour votre code

Pour migrer vers la V3, suivez ces étapes :

Si vous utilisez :
  • WordPress : mettez à niveau l'extension WordPress vers la dernière version.
  • Blogger : les utilisateurs de Blogger doivent supprimer l'ancien widget et réinstaller

1. Code d'installation

Actuellement, vous avez un code similaire à celui ci-dessous sur votre site web :

<div id="hyvor-talk-view"></div>
<script type="text/javascript">
	var HYVOR_TALK_WEBSITE = YOUR_WEBSITE_ID;
	var HYVOR_TALK_CONFIG = {
		url: false,
		id: false
	};
</script>
<script async type="text/javascript" src="//talk.hyvor.com/web-api/embed"></script>

Vous devez supprimer ce code de votre site web, puis suivre notre guide d'installation pour installer la version 3.

Important ! Lorsque vous modifiez le code, vous devez vous assurer que l'ancien HYVOR_TALK_CONFIG.id correspond à l'attribut page-id du nouvel élément <hyvor-talk-comments>.

Par exemple, si vous avez id: false comme suit :

var HYVOR_TALK_CONFIG = {
    id: false
}

Définissez page-id="" (l'URL canonique de la page sera utilisée pour l'identifier)

Si vous avez un ID dynamique similaire au code suivant :

var HYVOR_TALK_CONFIG = {
    id: "<?php echo $post->id; ?>"
}

Veillez à utiliser la même valeur : page-id="<?php echo $post->id; ?>" dans le nouvel élément.

2. SSO sans état

Si vous utilisez l'authentification unique sans état, vous devez mettre à jour le code qui génère les données utilisateur et le hash dans votre backend.

Voici les nouveautés :

  • Dans l'objet utilisateur, timestamp est désormais obligatoire (pour faire expirer les hashes).
  • L'objet utilisateur prend désormais en charge les champs bio, location et badges (facultatifs).
  • SHA256 est utilisé dans le HMAC à la place de SHA1
  • Les configurations SSO sont désormais ajoutées à l'élément <hyvor-talk-comments> au lieu de l'objet HYVOR_TALK_CONFIG.
  • L'URL de connexion est désormais ajoutée dans la console, et non plus dans le code de configuration.
  • L'URL d'inscription n'est plus prise en charge.

Consultez le guide du SSO sans état pour un tutoriel complet.

3. SSO OpenID Connect

Si vous utilisez le SSO OpenID Connect, une seule modification mineure est nécessaire. Ajoutez l'URL suivante comme URL de rappel dans votre fournisseur OpenID Connect :

https://talk.hyvor.com/embed/oidc

4. Webhooks

La V3 modifie le format des webhooks et la façon dont la signature est créée. Vous devez mettre à jour le code de vos webhooks pour prendre en charge le nouveau format.

Les modifications sont les suivantes :

  • Le corps du webhook est désormais un objet JSON au lieu d'une chaîne de requête.
  • Vous pouvez désormais générer un secret de webhook depuis la console.
  • Le champ signature n'est plus pris en charge.
  • L'en-tête X-Signature est désormais utilisé pour vérifier la signature.

Consultez les webhooks pour un tutoriel complet.

Hyvor Talk Logo