La API de Javascript de CookieHub proporciona un conjunto flexible de métodos y eventos públicos que permiten a los desarrolladores front-end interactuar con el widget CMP y controlarlo directamente en el sitio web. Esta API es esencial para garantizar un cumplimiento normativo sólido, ya que permite verificar manualmente el estado de consentimiento del usuario antes de ejecutar cualquier script de marketing, análisis o funcional de terceros.
Se accede a todas las funciones a través del objeto global window.cookiehub, que está disponible una vez inicializada la etiqueta de CookieHub.
El uso de la API garantiza que su sitio web sea compatible, dinámico y ofrezca una experiencia de usuario fluida.
Carga de script condicional
Utilice el método hasConsented() para cargar etiquetas de terceros (por ejemplo, Google Analytics, Facebook Pixel) solo si el usuario ha proporcionado la categoría de consentimiento requerida.
Integración en tiempo real
Utilice eventos como cookiehub_onStatusChange para activar scripts o actualizar su capa de datos en el momento en que un usuario cambia sus preferencias, sin necesidad de actualizar la página.
Experiencia de usuario personalizada
Cree botones o enlaces personalizados que abran programáticamente el cuadro de diálogo de consentimiento (openDialog()) o el panel de configuración (openSettings()) desde cualquier lugar de su sitio.
Flexibilidad del desarrollador
Proporciona métodos simples como allowAll() o denyAll() para escenarios de integración avanzados donde necesita control manual sobre los estados de consentimiento.
La funcionalidad de la API de Javascript se divide en dos grupos principales: Métodos Públicos (para consultar el estado y el control) y Eventos (para reaccionar a los cambios).
Para garantizar la disponibilidad del objeto de la API, se debe inyectar la etiqueta estándar de CookieHub en el encabezado <head> de su sitio web:
Guía de instalación: Información sobre el script a inyectar - Etiqueta de CookieHub
Estos métodos permiten comprobar activamente el estado de consentimiento del usuario o controlar la apariencia del cuadro de diálogo.
hasConsented(category)
Propósito: El método más crítico. Comprueba si el usuario ha permitido la categoría de cookies especificada (p. ej., "analytics", "marketing").
Ejemplo: if (window.cookiehub.hasConsented("analytics")) { loadAnalytics(); }
hasAnswered()
Propósito: Devuelve verdadero si el usuario ha seleccionado previamente permitir todas las opciones o guardar la configuración.
openSettings(tab)
Propósito: Abre el cuadro de diálogo de configuración. Opcionalmente, puede especificar una pestaña (p. ej., "declaration").
Ejemplo: window.cookiehub.openSettings('declaration');
openDialog()
Propósito: Abre programáticamente el cuadro de diálogo principal de consentimiento.
allowAll() / denyAll()
Propósito: Otorga o revoca programáticamente el consentimiento para todas las categorías. Útil para implementar controles personalizados fuera del cuadro de diálogo principal.
Los eventos son cruciales para ejecutar código después de que el usuario interactúe con la CMP. Escuche estos eventos utilizando el document.addEventListener estándar.
cookiehub_onInitialise
Disparador: Se activa cuando CookieHub se ha cargado y se conoce el estado de consentimiento actual del usuario.
Caso de uso clave: Ejecutar la lógica de la página inicial que depende del consentimiento previo.
cookiehub_onStatusChange
Disparador: Se activa cuando el usuario modifica sus preferencias de cookies (por ejemplo, hace clic en "Guardar configuración" o "Permitir todo").
Caso de uso clave: El evento más confiable para reactivar GTM o scripts después de actualizar el consentimiento.
cookiehub_onAllow
Disparador: Se activa cuando un usuario permite específicamente una categoría que previamente estaba deshabilitada.
Caso de uso clave: Cargar un único script dependiente de la categoría en el momento del consentimiento.
cookiehub_onRevoke
Disparador: Se activa cuando un usuario revoca específicamente el consentimiento para una categoría previamente permitida. Caso de uso clave: detener la ejecución de un script de seguimiento específico.
Todos los métodos y propiedades públicos están disponibles bajo el objeto global, window.cookiehub, una vez que se haya cargado la etiqueta principal CookieHub.
Sí, por supuesto. Si desactivas el icono flotante predeterminado en el panel de CookieHub, puedes crear un enlace o botón personalizado en cualquier lugar de tu sitio (por ejemplo, en el pie de página) que active el método público openDialog().
Sí. La declaración completa de cookies se puede incrustar directamente en cualquier página (como la página dedicada a la Política de Cookies) mediante un simple fragmento de HTML. Este método representa la declaración como una tabla sin estilo que hereda el CSS de su sitio web, lo que garantiza la coherencia visual. Cómo incrustar: Inserte el siguiente fragmento de HTML exactamente donde desea que aparezca la declaración: <div class="cookiehub-declaration"></div> Nota: Si desea que los usuarios vean la declaración dentro del cuadro de diálogo superpuesto de CMP, aún puede usar el método window.cookiehub.openSettings('declaration');.
Usa un método público (como hasConsented()) cuando tu código necesite consultar un estado o controlar el diálogo (una operación activa). Usa un evento (como cookiehub_onStatusChange) cuando tu código necesite reaccionar a una acción del usuario (una operación pasiva) o a un momento de inicialización.
No. Los métodos de la API como allowAll() o denyAll() están diseñados para ofrecer alternativas para que el usuario exprese su consentimiento (por ejemplo, mediante un botón personalizado). No deben utilizarse para eludir la decisión explícita del usuario ni el flujo de trabajo de la CMP.
El evento cookiehub_onStatusChange es el más fiable para la integración con GTM. Se activa siempre que el usuario modifica sus preferencias de cookies, lo que permite actualizar la capa de datos de GTM inmediatamente para reflejar el nuevo estado de consentimiento.
©2018-2025 CookieHub ehf.
CookieHub CMP offers tools and services for managing cookies and online privacy.
