L'API JavaScript de CookieHub offre un ensemble flexible de méthodes et d'événements publics permettant aux développeurs front-end d'interagir avec le widget CMP et de le contrôler directement sur le site web. Cette API est essentielle pour garantir une conformité rigoureuse en vous permettant de vérifier manuellement le consentement de l'utilisateur avant l'exécution de tout script tiers (marketing, analyse ou fonctionnalités).
Toutes les fonctionnalités sont accessibles via l'objet global `window.cookiehub`, disponible dès l'initialisation de la balise CookieHub.
L'utilisation de l'API garantit que votre site web est conforme, dynamique et offre une expérience utilisateur fluide.
Chargement conditionnel du script
Utilisez la méthode hasConsented() pour charger les balises tierces (par exemple, Google Analytics, Facebook Pixel) uniquement si l'utilisateur a fourni la catégorie de consentement requise.
Intégration en temps réel
Utilisez des événements comme cookiehub_onStatusChange pour déclencher des scripts ou mettre à jour votre couche de données dès qu'un utilisateur modifie ses préférences, sans nécessiter d'actualisation de la page.
Expérience utilisateur personnalisée
Créez des boutons ou des liens personnalisés qui ouvrent par programmation la boîte de dialogue de consentement (openDialog()) ou le panneau de paramètres (openSettings()) depuis n'importe où sur votre site.
Flexibilité du développeur
Fournit des méthodes simples comme allowAll() ou denyAll() pour les scénarios d'intégration avancés où vous avez besoin d'un contrôle manuel sur les états de consentement.
Les fonctionnalités de l'API JavaScript sont divisées en deux groupes principaux : les méthodes publiques (pour interroger l'état et gérer les modifications) et les événements (pour réagir aux changements).
Pour que l'objet API soit disponible, la balise CookieHub standard doit être injectée dans l'en-tête (<head>) de votre site web :
Guide d'installation : Informations sur le script à injecter - Balise CookieHub
Ces méthodes permettent de vérifier activement le statut de consentement de l'utilisateur ou de contrôler l'apparence de la boîte de dialogue.
hasConsented(category)
Objectif : Méthode essentielle. Vérifie si l’utilisateur a autorisé la catégorie de cookies spécifiée (par exemple, « analytics », « marketing »).
Exemple : if (window.cookiehub.hasConsented("analytics")) { loadAnalytics(); }
hasAnswered()
Objectif : Renvoie true si l’utilisateur a déjà fait un choix en autorisant tous les cookies ou en enregistrant les paramètres.
openSettings(tab)
Objectif : Ouvre la boîte de dialogue des paramètres. Vous pouvez spécifier un onglet (par exemple, « declaration »).
Exemple : window.cookiehub.openSettings('declaration');
openDialog()
Objectif : Ouvre par programmation la boîte de dialogue de consentement principale.
allowAll() / denyAll()
Objectif : Accorde ou révoque par programmation le consentement pour toutes les catégories. Utile pour implémenter des contrôles personnalisés en dehors de la boîte de dialogue principale.
Les événements sont essentiels pour exécuter du code après l'interaction de l'utilisateur avec le CMP. Écoutez ces événements à l'aide de la méthode standard `document.addEventListener`.
cookiehub_onInitialise
Déclencheur : Déclenché lorsque CookieHub est chargé et que le statut de consentement de l’utilisateur est connu.
Cas d’utilisation principal : Exécution de la logique initiale de la page dépendant d’un consentement préalable.
cookiehub_onStatusChange
Déclencheur : Déclenché chaque fois que l’utilisateur modifie ses préférences de cookies (par exemple, en cliquant sur « Enregistrer les paramètres » ou « Autoriser tout »).
Cas d’utilisation principal : Événement le plus fiable pour redéclencher GTM ou des scripts après la mise à jour du consentement.
cookiehub_onAllow
Déclencheur : Déclenché lorsqu’un utilisateur autorise explicitement une catégorie précédemment interdite.
Cas d’utilisation principal : Chargement d’un script spécifique à la catégorie au moment du consentement.
cookiehub_onRevoke
Déclencheur : Déclenché lorsqu’un utilisateur retire explicitement son consentement pour une catégorie précédemment autorisée.
Cas d’utilisation principal : Arrêt de l’exécution d’un script de suivi spécifique.
Toutes les méthodes et propriétés publiques sont disponibles sous l'objet global window.cookiehub, une fois que la balise principale CookieHub est chargée.
Oui, absolument. Si vous désactivez l'icône flottante par défaut dans le tableau de bord CookieHub, vous pouvez créer un lien ou un bouton personnalisé n'importe où sur votre site (par exemple, dans le pied de page) qui déclenche la méthode publique openDialog().
Oui. La déclaration complète relative aux cookies peut être intégrée directement sur n'importe quelle page (par exemple, votre page dédiée à la politique de cookies) à l'aide d'un simple extrait de code HTML. Cette méthode affiche la déclaration sous forme de tableau sans style, qui hérite du CSS de votre site web, garantissant ainsi une cohérence visuelle. Comment l'intégrer : Insérez l'extrait de code HTML suivant à l'endroit précis où vous souhaitez que la déclaration apparaisse : <div class="cookiehub-declaration"></div> Remarque : Si vous souhaitez que les utilisateurs voient la déclaration dans la boîte de dialogue superposée du CMP, vous pouvez toujours utiliser la méthode window.cookiehub.openSettings('declaration');.
Utilisez une méthode publique (comme `hasConsented()`) lorsque votre code doit interroger un statut ou gérer la boîte de dialogue (opération active). Utilisez un événement (comme `cookiehub_onStatusChange`) lorsque votre code doit réagir à une action de l'utilisateur (opération passive) ou à une initialisation.
Non. Les méthodes API telles que allowAll() ou denyAll() sont conçues pour offrir à l'utilisateur d'autres moyens d'exprimer son consentement (par exemple, via un bouton personnalisé). Elles ne doivent pas être utilisées pour contourner le choix explicite de l'utilisateur ou le flux de travail de la plateforme de gestion du consentement.
L'événement cookiehub_onStatusChange est le plus fiable pour l'intégration de GTM. Il se déclenche à chaque modification des préférences de l'utilisateur concernant les cookies, ce qui vous permet de mettre à jour immédiatement votre couche de données GTM afin de refléter le nouveau niveau de consentement.
©2018-2025 CookieHub ehf.
CookieHub CMP offers tools and services for managing cookies and online privacy.


