Artículos sobre: API JS
Este artículo también está disponible en:

API de JavaScript (versión antigua)

Este artículo se aplica al Legacy Banner. Si usas el nuevo banner (v5+), consulta el artículo API de JavaScript (versión nueva).


Descripción general

La API de JavaScript de Pandectes permite que tu tienda interactúe con el banner de consentimiento sin depender únicamente del comportamiento integrado del banner. Ofrece a los desarrolladores un conjunto de herramientas para leer el estado actual del banner y del consentimiento, activar acciones y escuchar eventos, todo ello desde el tema de tu tienda o desde scripts personalizados. Esta página describe las funciones disponibles en la versión de la API del Legacy Banner.


¿Qué puedes hacer con la API de JavaScript Legacy?

Leer el estado del banner y del consentimiento

La API expone un conjunto de propiedades de solo lectura que reflejan el estado actual del banner y del consentimiento del visitante en cualquier momento. Puedes comprobar:

  • Si la API y el banner se han cargado por completo y están listos para usarse
  • Si el banner está visible actualmente en pantalla
  • Si el banner es aplicable al visitante actual (según las reglas de geolocalización)
  • Si la geolocalización está activa y en qué país se detecta al visitante
  • En qué idioma se muestra actualmente el banner
  • El estado de consentimiento del visitante para cada categoría de cookies: estrictamente necesarias, funcionalidad, rendimiento, targeting y cookies sin clasificar
  • Si el visitante ha hecho clic en Allow, Decline o Dismiss en el banner

Esto ofrece a tu tienda una instantánea en tiempo real de lo que ha aceptado exactamente un visitante y de cómo ha interactuado con el banner.


Controlar la visualización del banner

La API te permite mostrar u ocultar el banner de forma programática, en lugar de depender solo de las reglas de visualización automáticas. En concreto, puedes:

  • Mostrar el banner — forzar que el banner de consentimiento aparezca para el visitante
  • Ocultar el banner — retirarlo de la vista, con la opción de mostrar u ocultar al mismo tiempo el botón de revocar/reabrir
  • Mostrar u ocultar el botón de revocar — el pequeño botón que permite a los visitantes volver a abrir el banner después de haber tomado ya una decisión

Esto es útil cuando quieres activar el banner en respuesta a una acción concreta del usuario, como hacer clic en un enlace "Cookie settings" del pie de página.


Abrir y cerrar la ventana emergente de preferencias

Además del banner principal, la API también te da control sobre la ventana emergente de preferencias de cookies, el panel donde los visitantes pueden aceptar o rechazar categorías de cookies individuales. Puedes:

  • Abrir directamente la ventana emergente de preferencias
  • Cerrarla de forma programática
  • Guardar las preferencias actuales del visitante y cerrar la ventana emergente en una sola acción
  • Establecer el estado de las casillas de las categorías individuales dentro de la ventana emergente
  • Aplicar cambios de consentimiento a nivel de categoría con distintos niveles de granularidad

Esto permite flujos de consentimiento totalmente personalizados en los que el panel de preferencias se activa o se gestiona fuera del propio banner.


Activar una revocación del consentimiento

La API te permite revocar de forma programática el consentimiento dado previamente por un visitante. Esto restablece su estado de consentimiento y, por defecto, vuelve a abrir el banner para que pueda tomar una nueva decisión. Opcionalmente, se puede impedir que el banner se reabra automáticamente si prefieres gestionar tú mismo ese paso.


Forzar una acción de "salir del sitio"

La API incluye un método para activar la funcionalidad de salir del sitio, la misma acción que se produce cuando un visitante hace clic en un botón de salir del sitio en el banner. Es útil en escenarios en los que quieres ofrecer a los visitantes una forma explícita de salir de la tienda como parte de un flujo de privacidad personalizado.


Escuchar eventos del banner y del consentimiento

La API dispara eventos en momentos clave del ciclo de vida del banner, para que tu tienda pueda reaccionar en tiempo real. Puedes escuchar cuando:

  • La API de Pandectes se ha inicializado y está lista
  • La página se ha cargado por completo
  • Se ha detectado la ubicación del visitante (útil para la lógica basada en geolocalización)
  • Se ha establecido el idioma del banner
  • El banner pasa a ser visible
  • El banner se oculta
  • El visitante hace clic en el botón de salir del sitio
  • El banner se cierra (después de una decisión de consentimiento)
  • Se toma o actualiza una decisión de consentimiento
  • El visitante abre el panel de preferencias

Estos eventos permiten que otros scripts e integraciones de tu tienda respondan de inmediato a los cambios de consentimiento, por ejemplo, cargando un script de seguimiento en el momento en que un visitante concede el consentimiento, sin necesidad de recargar la página.


¿A quién va dirigida?

La API de JavaScript está pensada para comerciantes con un desarrollador o para tiendas que usan un storefront personalizado o headless. El banner funciona por completo por sí solo sin usar la API; esta es para escenarios avanzados en los que se necesita una integración más estrecha con el comportamiento de tu tienda.


Primeros pasos

Para ver la referencia completa de la API, ve a Settings → JavaScript API dentro de la aplicación Pandectes. Si necesitas ayuda con un caso de uso concreto, ponte en contacto con nuestro equipo de soporte.

Actualizado el: 19/10/2026

¿Este artículo te resultó útil?

Comparte tu opinión

Cancelar

¡Gracias!