1. Casa
  2. Docs
  3. Documentación del desarrollador
  4. Complementos / Bibliotecas
  5. Kit de galletas XcooBee

Kit de galletas XcooBee

Descargar y usar

Publicado como código abierto bajo licencia Apache-2.0

https://www.npmjs.com/package/xcoobee-cookie-kit-web

Cuál es la diferencia

XCK es un marco activo de gestión de cookies y consentimiento para su sitio. Esto es diferente de un cuadro de texto basado solo en notificaciones de cookies.

La mayoría de los avisos GDPR de cookies actuales para sitios web son solo eso: superposiciones que muestran información pero no gestionan activamente la creación de cookies y los ciclos de vida. Todavía es responsable de manejar las cookies y las huellas digitales correctamente. En contraste con esto, el XcooBee Cookie Kit es un verdadero administrador de cookies y de ciclo de vida. Le ayudará a implementar las premisas del GDPR y la directiva electrónica europea correctamente.

Ejemplo de inicio súper rápido

  1. Cargue la biblioteca desde el CDN usando la etiqueta de script:
<script id="xcoobee-cookie-kit" src="https://app.xcoobee.net/scripts/kit/xcoobee-cookie-kit.min.js"></script>
  1. Configure sus cookies administradas con etiqueta en tu DOM HTML así:
 abhchkshsdh  azul oscuro 
  1. Inicialice el kit de cookies para administrar las cosas al final de la representación de su página:
<script>
  function blankCh(){};

  XcooBee.kit.initialize({
    checkByDefaultTypes: ["application","usage"],
    cookieHandler: "blankCh",
    position: "right_bottom",
    privacyUrl: "#privacyUrl",
    requestDataTypes: ["application", "usage", "statistics"],
    termsUrl: "#termsUrl",
    textMessage: "Welcome to our site. We manage cookies responsibly and listen to our users. You can check and uncheck which types are OK."    
  });
</script>

Ver Parámetros de referencia para todas las cosas que puedes hacer.

Hecho !!

Este fue un ejemplo súper simple, el XCK asumirá tareas relacionadas con GDPR y directivas electrónicas desde aquí. Por supuesto, hay muchos más ejemplos detallados más adelante.

Vídeo

Tutorial del kit de galletas

¿Qué es el XCK?

El objetivo del Kit de cookies XcooBee (XCK) es permitir que los sitios web administren su consentimiento de cookies de manera más efectiva y con menos molestia para sus usuarios. El XCK puede trabajar en concierto con la red XcooBee para mejorar la administración general de usuarios y empresas, pero eso no es obligatorio. Cuando el XCK funciona independientemente de XcooBee, algunas funciones de administración no estarán disponibles.

El XCK facilita agregar administración de consentimiento de cookies en su sitio web. Maneja toda la interacción del usuario para obtener el consentimiento y le permite al sitio web saber qué cookies se pueden usar para cada usuario mientras visita su sitio web. Del mismo modo, su sitio web ahora puede ser informado cuando los usuarios cambian su consentimiento, incluso cuando no lo están visitando.

XCK es una de las formas más transparentes y sin fricciones para administrar las cookies en su sitio. No aparecerá, no obstaculizará la experiencia del usuario cuando no sea necesario. Sin embargo, al mismo tiempo, cumple con las directivas electrónicas europeas y las normas GDPR relacionadas.

Los propietarios de sitios web pueden reaccionar fácilmente a las solicitudes de datos e informar sobre solicitudes relacionadas con la privacidad si es necesario a través de la red XcooBee.

XCK no requiere una conexión XcooBee para funcionar en su sitio web. Aún tendrá acceso a la mayoría de la recopilación de consentimiento de los usuarios, pero no tendrá una visión central y una gestión del consentimiento.

El XCK es receptivo y se ajustará fácilmente a diferentes pantallas, incluidos los usos móviles.

Inicio rápido para llegar a ejemplos de etiquetas

Caracteristicas

Con el kit de galletas puedes:

  • use la clasificación previa de cookies de XcooBee para presentar detalles simplificados y claros de cómo usará las cookies
  • comparte tus políticas de cookies
  • comparte tus términos de servicio
  • comparte tu política de privacidad
  • determinar las interacciones del configurador / desensamblador de cookies
  • integrarse con servicios de back-end para notificaciones de cookies
  • determinar de manera transparente si la notificación es necesaria
  • permitir a los usuarios eliminar / agregar consentimiento para cookies
  • establecer el tiempo y la posición de la pantalla de información
  • reaccionar adecuadamente a las solicitudes de consentimiento y eliminación de consentimiento del usuario

Con la suscripción a XcooBee también puedes:

  • documentar sus interacciones de consentimiento de cookies
  • gestionar de forma remota el consentimiento del usuario
  • documentar el tiempo de respuesta adecuado a las solicitudes de los usuarios
  • establecer elementos de estilo y logotipo adicionales
  • permite a los usuarios utilizar la inteligencia de cookies multitud

Clasificación fácil de cookies

XCK utiliza un sistema de clasificación para cookies en lugar de enumerar cada cookie individual con su origen. Al poner las cookies en grupos lógicos, XCK elimina la necesidad de experiencia técnica para distinguir las cookies individuales. Los usuarios pueden tomar una decisión más fácil en función del uso previsto de la cookie en lugar del nombre de dominio o cualquier otro criterio técnico.

El sistema de clasificación XcooBee coloca en general las cookies en uno de los siguientes tipos:

  • Cookies requeridas o de aplicación
  • Cookies de personalización
  • Cookies de estadísticas
  • Cookies de publicidad y marketing

Para mayor información por favor visite Clasificación de cookies XcooBee.

Aplicaciones de ejemplo

Hemos incluido tres aplicaciones de ejemplo que hacen uso de XCK para que pueda verlo usted mismo en acción.

Solicitud de página única

Nuestra aplicación de café demuestra el uso de XCK en una aplicación de una sola página. Puede descomprimir e implementar en un servidor web como IIS o Apache. Los archivos se encuentran en ejemplos / cafe-spa.zip. Revisa el index.html archivo de instrucciones / explicaciones.

Cookie Kit Simple HTML App

Aplicación de solicitud / respuesta de muestra basada en NodeJs & Express

Nuestra aplicación de pizza demuestra el uso de XCK en una aplicación basada en solicitud / respuesta. Puede descomprimirlo e implementarlo directamente en su sistema. Necesitará nodejs instalados en su sistema para algunos. Revisa el README.md archivo de instrucciones / explicaciones en cada una de las aplicaciones de ejemplo de página única (SPA), Express y ReactJS:

Aplicación de ejemplo del kit de cookies

Aplicación basada en ReactJS de muestra

Un clon de nuestra aplicación de café para demostrar el uso de XCK con React. Estamos utilizando la React Build especial de XCK para esto y debe revisar el kit-reaccionar-cookie en npm js.

Aplicación de React de ejemplo de Kit de cookies

Como funciona esto

La galleta

the cookie

El XCK muestra un icono de cookie flotante en la pantalla en una esquina de su elección. Este es el punto de partida para la interacción del usuario. Al hacer clic en el icono de la cookie, los usuarios abren un cuadro de diálogo de consentimiento emergente que les permite interactuar con su sitio.

Si XCK determina que se necesita el consentimiento del usuario, irá al siguiente paso y abrirá el cuadro de diálogo emergente de XCK:

El diálogo emergente

showing XCK cookie popup

El XCK puede determinar automáticamente cuándo se necesita un diálogo de consentimiento completo o solo la cookie. Por lo tanto, hacer que la visita al sitio sea más agradable y sin fricciones.

Al usar el XCK usted:

  • a) primero determine qué cookies está utilizando actualmente en su sitio
  • b) luego seleccione qué tipo de cookie XcooBee (clasificación) que mejor se adapta a cada cookie
  • c) muestre a los visitantes de su sitio la ventana emergente de diálogo de consentimiento de XCK para solicitar permiso
  • d) después de obtener el consentimiento para un tipo de cookie, configure las cookies en ese grupo para su usuario utilizando un controlador dentro del JavaScript del cliente o el patrón de URL de destino a través de la sintaxis del servidor (PHP, JSP, .net, etc.) o ambos.

Si ya se obtuvo el consentimiento de la cookie, XCK no mostrará otra ventana emergente. Puede consultar el estado a través de JavaScript para configurar las cookies nuevamente, o realizar un seguimiento de este en el lado del backend si está utilizando la aplicación de tipo Solicitud / Respuesta.

Ejemplo a pie a través de

Supongamos un ejemplo de un sitio de compras impulsado por JSP que utiliza cuatro cookies. Aquí hay un proceso de muestra para implementar la gestión adecuada del consentimiento de cookies utilizando XCK:

una Usted determina que usa las siguientes cuatro cookies en su sitio.

  1. Su cookie de sesión JSP
  2. Una cookie de usuario para realizar un seguimiento del tema del usuario.
  3. Una cookie de estadísticas del sitio de su servidor web
  4. Una cookie de estadísticas globales de Google Analytics

si Clasifica las cookies en los siguientes tipos

Aplicación: Cookie de sesión JSP

Personalización: cookie de usuario

Estadísticas: cookie de servidor web local y cookie de google analytics

C usted inicializar y renderizar el script XCK para mostrar la ventana emergente de consentimiento del usuario.

re El usuario realiza una selección y hace clic en Aceptar.

mi XCK invoca el proceso del controlador de JavaScript de su sitio que establece o elimina las cookies.

Pulsos de galletas

El kit de cookies utiliza un método de evaluación de acceso directo para verificar si ya ha obtenido el consentimiento para las cookies del usuario. Esto agiliza la configuración de cookies. Cuando esto tiene éxito, el icono de cookie que se coloca en una esquina designada, se reemplaza por pulsos. Hay diferentes pulsos de color para indicar que se ha producido una selección de acceso directo.

Verde: aprobación explícita del usuario

green cookie pulse

El pulso verde indica que el usuario ha visitado este sitio antes y que la configuración de consentimiento de cookies del sitio es conocida y se puede volver a aplicar.

Azul: aprobación basada en preferencias

blue cookie pulse

El pulso azul indica que aunque el usuario no ha visitado este sitio antes, ha establecido preferencias de consentimiento para nuevos sitios que pueden aplicarse. Esto solo es posible cuando el usuario y el sitio web son miembros de la red XcooBee.

Amarillo: aprobación basada en inteligencia de multitudes

yellow cookie pulse

El pulso amarillo indica que el usuario ha elegido participar en el programa XcooBee Crowd AI para cookies. La red XcooBee utilizará un análisis basado en multitud y establecerá las cookies en función de los comentarios de los visitantes del sitio web. Esto solo es posible cuando el usuario y el sitio web son miembros de la red XcooBee.

Rojo: uso de preferencias del sitio web

red cookie pulse

El pulso rojo indica que no tenemos ninguna información directamente del usuario. En tal caso, el propietario del sitio web puede seleccionar usar las preferencias del sitio web para las cookies en lugar de las preferencias del usuario. Esto solo se puede hacer si el sitio web y el usuario se encuentran fuera de la UE.

Instalar en pc

Active el XCK al insertarlo en su sitio a través de Etiquetas Además, durante la invocación, proporciona parámetros adicionales a la etiqueta del script.

Algunos de estos incluyen:

  • posición del botón del icono
  • términos url
  • URL de política de cookies
  • tiempo de vencimiento del widget
  • mensaje de texto
  • función de manejo de cookies
  • valores predeterminados del sitio
  • URL de destino

Cuando se suscribe a XcooBee también puede especificar:

  • su referencia de campaña
  • logo de la compañía
  • cssAutoLoad

UNA ID de campaña es necesario para que XCK se comunique con XcooBee y permita la gestión de consentimientos. Por favor visita XcooBee si necesita crear una cuenta Sin él, el XCK funcionará en modo fuera de línea.

Modos de operacion

El XCK funciona en dos modos. Uno, en modo desconectado, donde XCK y su sitio web interactúan directamente sin el uso de la red XcooBee. Dos, en modo conectado, donde XCK interactúa con la red XcooBee para permitir que las empresas documenten y administren el consentimiento de las cookies, al tiempo que brinda a los usuarios herramientas adicionales para administrar y simplificar el manejo de cookies.

A continuación explicamos cómo funciona cada modo.

Modo desconectado

diagram showing XCK in disconnected mode

En modo desconectado,

  1. su sitio web carga y procesa su contenido sin configurar cookies
  2. carga el XCK con sus parámetros
  3. XCK maneja la interacción del usuario para el consentimiento de cookies
  4. comunica a su sitio qué tipos de cookies se pueden configurar.

Su sitio, entonces, establece las cookies de acuerdo con las preferencias del usuario.

Modo conectado

alt text

El modo conectado es similar en el proceso con diferencias en cada paso para reflejar herramientas adicionales:

En modo conectado,

  1. su sitio web carga y procesa su contenido sin configurar cookies
  2. carga el XCK con sus parámetros, incluidas las referencias de su campaña
  3. XCK maneja la interacción del usuario para el consentimiento de cookies. Para los usuarios de XcooBee, XCK negocia de manera transparente con su sitio según las preferencias del usuario. Los usuarios de XcooBee pueden navegar por sitios con poca interrupción.
  4. XCK le comunica a su sitio qué tipos de cookies se pueden configurar. Su sitio, luego establece las cookies de acuerdo con las preferencias del usuario.
  5. Como propietario del sitio, puede revisar todo el consentimiento de cookies administrado. Informe sobre problemas de cumplimiento, tome medidas cuando los usuarios cambien su consentimiento incluso cuando no visiten su sitio. Los visitantes de su sitio (usuarios) pueden gestionar activamente el consentimiento de cookies de forma centralizada y navegar de forma transparente por su sitio sin molestos popups.

Cómo usar el kit de cookies XcooBee

Esta sección explica cómo usar el XCK en su sitio.

Cómo usar el Kit de cookies en la Aplicación de página única (SPA)

Al usar un SPA, puede especificar un controlador de JavaScript que pueda recibir el resultado de la interacción del usuario para el consentimiento de las cookies. Posteriormente, debe cargar los scripts y / o configurar las cookies directamente en función de la interacción del usuario.

Como esto puede cambiar, también debe ser capaz de eliminar las cookies cuando los usuarios cambien de opinión.

En ambos casos, XCK invocará su función de controlador después de que el usuario haya completado su interacción con XCK.

XCK llamará a su controlador de JavaScript con un objeto de JavaScript. Las preferencias del usuario se enumeran en el argumento.

Puedes encontrar un ejemplo de SPA en github.

Aquí hay un objeto de ejemplo.

{"aplicación": verdadero, "uso": verdadero, "estadísticas": falso, "publicidad": falso}

Por lo tanto, la firma de la llamada será: handlerFunction (cookieObject).

Por ejemplo, si su función de controlador se llama cookieHandler y el objeto argumento de la función se llama userCookiePreferences Esta sería la firma de su función:

cookieHandler (userCookiePreferences);

Función de cookieHandler de muestra:

función cookieHandler (consentSettings) {if (consentSettings.application) {// establezca las cookies requeridas aquí // ...} más {// elimine las cookies requeridas aquí // ...}; if (consentSettings.usage) {// establezca las cookies de personalización del usuario aquí // ...} más {// elimine las cookies de personalización del usuario aquí // ...}; if (consentSettings.statistics) {// establece las estadísticas del sitio que recopilan cookies aquí // ...} más {// elimina las estadísticas del sitio que recopilan cookies aquí // ...}; if (consentSettings.advertising) {// establezca cookies de publicidad y marketing y seguimiento aquí // ...} más {// elimine las cookies de publicidad y marketing y seguimiento aquí // ...}; }

Ver más ejemplo completamente desarrollado más adelante en este documento.

Cómo usar el Kit de cookies con sistemas de solicitud / respuesta como PHP, Node, JSP, .net, CFML, etc.

XCK puede comunicar a los usuarios la concesión y eliminación de consentimiento para cookies a su sitio a través de la publicación webhook (HTTP POST) también. Necesitará un punto final accesible desde la web tal como se define en targetUrl que puede procesar estos mensajes y establecer / deshabilitar las cookies por tipo de cookie.

Sin embargo, dependiendo de su situación, es posible que pueda manejar todas las interacciones dentro de JavaScript sin recargas o llamadas al backend (vea el ejemplo a continuación)

HTTP POST usará TIPO DE CONTENIDO = aplicación / json

El contenido del cuerpo es un objeto JSON con la selección de tipos de cookies por parte del usuario. Solo se incluirán los tipos de cookies para los que ha solicitado su consentimiento.

{"tiempo": "2018-10-31T16: 40: 28", "código": 200, "resultado": {"aplicación": verdadero, "uso": falso, "estadísticas": verdadero}}

Dónde:

hora => fecha de la decisión en código UTC => 200 para resultado exitoso => el JSON con información sobre tipos de cookies

Un proceso de muestra para manejar el consentimiento de cookies a través de una Solicitud / Respuesta y un página de manejador El patrón podría verse así. Tu página de manejador Es muy probable que sea un fragmento de código que deberá incluirse en todas las llamadas de representación de páginas. También deberá poder llamarlo de forma independiente.

  1. Su sistema se inicia sin cookies.
  2. Si no se definen cookies, invoque el XCK
  3. XCK obtiene el consentimiento del usuario y llama al página de manejador identificado en targetUrl parámetro
  4. página de manejador guarda la decisión del usuario y marca que el usuario ha tomado una decisión
  5. para cada llamada posterior, el página de manejador comprueba que la decisión del usuario esté disponible y establece los tipos de cookies

Tu página de manejador probablemente empleará este tipo de lógica

  • determinar si se trata de una llamada regular (incluida) o una llamada de XCK para guardar la decisión del usuario
  • si llamada regular
    • determinar si tenemos una decisión del tipo de cookie del usuario
    • si no tenemos decisión -> cargar XCK insertando etiquetas en HTML para presentar la opción de cookies al usuario
    • si tenemos una decisión de cookie de usuario -> cargar cookies para cada tipo permitido
  • si se llama desde XCK
    • guardar la decisión de la cookie del usuario

    También puedes revisar nuestro ejemplo de aplicación Express / NodeJs en Github.

Ejemplo de uso con la página PHP combinada con el Kit de cookies

En este ejemplo, suponemos que tenemos un sitio web que ejecuta un motor PHP para representar páginas web. Como parte de este proceso, el sitio web cargará el XCK para administrar el consentimiento del usuario. Estás gestionando la creación de cookies a través de JavaScript.

El proceso de gestión se divide en este flujo:

a. La página PHP escribe los valores para cada tipo de cookie en la secuencia HTML / Javascript

si. Incluir código de controlador JS (ejemplo a continuación)

C. Cargar XCK

una Canalizar variables PHP con etiquetas de script en HTML

En este ejemplo, asumimos que tiene JS etiquetas para todas las cookies que necesita crear y guardarlas en las variables PHP correspondientes de esta manera:

$cookie_scripts_application => las cookies de aplicación requeridas, por ejemplo, por ejemplo:  $cookie_scripts_user => las cookies de personalización del usuario, por ejemplo:  $cookie_scripts_statistics => las cookies de estadísticas del sitio, por ejemplo:  $cookie_scripts_advertising => las cookies de publicidad del sitio, por ejemplo: 

Debería generar cada uno de estos códigos HTML, así

<script>
// define cookie script management scope in JS
var myCookieScripts = {};

// most likely we can set this directly since these would be required
myCookieScripts.application = "<?php echo htmlentities(preg_replace( "/\r|\n/", "", $cookie_scripts_application )); ?>";

myCookieScripts.user = "<?php echo htmlentities(preg_replace( "/\r|\n/", "", $cookie_scripts_user )); ?>";

myCookieScripts.statistics = "<?php echo htmlentities(preg_replace( "/\r|\n/", "", $cookie_scripts_statistics )); ?>";

myCookieScripts.advertising = "<?php echo htmlentities(preg_replace( "/\r|\n/", "", $cookie_scripts_advertising )); ?>";
</script>

si escribir un controlador JS

Necesita definir su controlador en JS. Incluimos algunas funciones auxiliares que realmente configurarán sus cookies y cargarán sus scripts.

  /**
   * parse html encoded script directives
   * @param {string} htmlData - string with script tags to be loaded
   * @return {object} the fully parsed html elements
   */
  function xckParseHtml(htmlData) {
    //parse encoded via text area
    var txt = document.createElement("textarea");
    txt.innerHTML = htmlData;

    // now add this as html to our mirror doc
    var el=document.createElement("html");
    el.innerHTML = txt.innerText;
    return el;
  }

  /**
   * Load Javascript. Can load from remote file or code.
   * @param {object} loadScripts - The HTMLCollection of scripts to be loaded
   */
  function xckLoadJs(loadScripts) {
    var i = 0;
    if (loadScripts.length > 0){
      for (i = 0; i < loadScripts.length; i++) {
        var item = loadScripts[i];
        var script = document.createElement("script");

        if (item.src === "") {
          script.text = item.text;
        } else {
          // load from file
          script.async = true; // we always load async
          script.src = item.src;
          script.onload = function () {
            console.log(`cookie script from ${item.src} is ready!`);
          };

          // other elements
          if (item.integrity !== "") {
            script.integrity = item.integrity;
          }
          if (item.crossOrigin !== "") {
            script.crossOrigin = item.crossOrigin;
          }
        }

        // now append to document for execution
        document.body.appendChild(script);
      }
    }
  }

  /**
   * This will be invoked by XCK when user clicks OK button
   * @param {object} consentSettings - The collection containing user decisions
   */
  function myCookieHandler(consentSettings) {
    // parse cookie scripts passed from PHP

    if (consentSettings.application) {
      // parse cookie scripts passed from PHP
      let myEl = xckParseHtml(myCookieScripts.application);
      let appScripts = myEl.getElementsByTagName("script");
      // set required cookies here
      xckLoadJs(appScripts);
    } else {
      // remove required cookie here
      // ...
    };

    if (consentSettings.usage) {
      // parse cookie scripts passed from PHP
      let myEl = xckParseHtml(myCookieScripts.user);
      let userScripts = myEl.getElementsByTagName("script");
      // set required cookies here
      xckLoadJs(userScripts);
    } else {
      // remove user personalization cookies here
      // ...
    };

    if (consentSettings.statistics) {
      // parse cookie scripts passed from PHP
      let myEl = xckParseHtml(myCookieScripts.statistics);
      let statScripts = myEl.getElementsByTagName("script");
      // set required cookies here
      xckLoadJs(statScripts);
    } else {
      // remove site statistics gathering cookies here
      // ...
    };

    if (consentSettings.advertising) {
      // parse cookie scripts passed from PHP
      let myEl = xckParseHtml(myCookieScripts.advertising);
      let adsScripts = myEl.getElementsByTagName("script");
      // set required cookies here
      xckLoadJs(adsScripts);
    } else {
      // remove advertising and marketing and tracking cookies here
      // ...
    };
  }

C Cargue el kit de galletas XcooBee

Como se describe en algunas áreas, cuando desee iniciar el diálogo XCK, incluya el etiquetas en su flujo HTML.

<script id="xcoobee-cookie-kit" src="https://app.xcoobee.net/scripts/kit/xcoobee-cookie-kit.min.js"></script>
<script>
  XcooBee.kit.initialize({
    checkByDefaultTypes: ["application"],
    cookieHandler: "myCookieHandler",
    position: "right_bottom",
    privacyUrl: "http://mysite.com/privacy",
    requestDataTypes: ["application", "usage", "statistics"],
    termsUrl: "http://mysite.com/terms",
    textMessage: "Welcome to our shopping site. We use cookies to deliver a better service to you. Please let us know if this is OK."
  });
</script>

Cómo usar XCK con suscripción a XcooBee e intercambio de datos de alta seguridad

Cuando tiene una suscripción a XcooBee, su sitio web también puede recibir actualizaciones sobre el consentimiento otorgado cuando el usuario no está directamente en línea a través de la red XcooBee. Esta comunicación ocurrirá a través de webhooks y un mayor nivel de encriptación.

Como alternativa a HTTP POST directo, su suscripción a la red XcooBee también permite el sondeo de eventos para que pueda usar XCK para sitios que no son directamente accesibles a través de Internet, es decir, sitios de intranet o sitios en desarrollo.

Debe poder procesar los mensajes de XcooBee que utilizan cifrado PGP además de HTTPS / TLS.
El patrón del mensaje es el mismo que el descrito en la sección anterior.

Puede usar uno de los SDK de XcooBee para simplificar esta interacción:

El uso de la red XcooBee no es una interacción requerida. Los usuarios actualizarán de manera transparente sus preferencias de cookies con su sitio cada vez que lo visiten.

Cookies y scripts administrados

La mayoría de los avisos de cookies no implementan la gestión del ciclo de vida, y si usted, como programador, no implementa el comportamiento correcto para los eventos de interacción con el usuario, aún fallará su auditoría GDPR y su empresa puede ser responsable de fallas de cumplimiento. El XCK le ofrece una alternativa muy simple que le permite cumplir fácilmente.

El uso de cookies y scripts administrados es la forma más fácil de declarar y administrar cookies con XCK. Este enfoque permite que XCK administre el ciclo de vida de sus cookies desde la creación hasta la destrucción. Requiere solo cambios mínimos de aplicación. Mientras su aplicación pueda escribir una etiqueta HTML, puede crear cookies y scripts administrados.

Las características se implementan a través de dos extensiones de etiquetas HTML adicionales que puede usar:

Necesita tanto una etiqueta de apertura como una de cierre.
Debe declarar todas sus etiquetas antes de llamar a XCK inicializar() función.

etiqueta xbee-cookie

los La etiqueta le permite declarar una cookie administrada singular.

Es una declaración de cookies que puede agregar en cualquier lugar del HTML DOM donde desee configurar las cookies.
El XCK gestionará el ciclo de vida, incluida la eliminación automática.
Si es posible, las etiquetas deben escribirse en una línea:

valor supercookie

El valor de la cookie está entre abrir y cerrar etiquetas (innerHTML).

Atributos:

  nombre => el nombre de la cookie que desea establecer categoría => una de las categorías de cookies: aplicación, uso, estadísticas, días de publicidad => opcional: el número de días para configurar la cookie, si no se proporciona, caducará con la sesión

Ejemplos:

 este es un valor de la cookie  gran galleta 

etiqueta xbee-script

Si está configurando cookies a través de scripts remotos o tiene que cargar scripts de terceros que configuran algunas cookies, la forma más fácil de administrarlas es usar el etiqueta.

La etiqueta xbee-script funciona como la etiqueta de script HTML pero tiene dos atributos adicionales. Esto le permite convertir fácilmente los existentes etiquetas en Etiquetas

El contenido de la etiqueta es Javascript que se ejecutará más tarde después de obtener el consentimiento de los usuarios. También puede especificar scripts remotos a través de src atribuir como de costumbre. Tendrá que agregar una etiqueta de cierre como una sola línea de cierre automático No se permite:

en su lugar usa esto

Atributos Adicionales:

  action => uno de "set" o "unset", puede proporcionar scripts de limpieza con la categoría de atributo "unset" => una de las categorías de cookies: aplicación, uso, estadísticas, publicidad

Ejemplo:

   (función (i, s, o, g, r, a, m) {i ['GoogleAnalyticsObject'] = r; i [r] = i [r] || function () {(i [r] .q = i [r] .q || []). push (argumentos)}, i [r] .l = 1 * nueva Fecha (); a = s.createElement (o), m = s.getElementsByTagName (o) [ 0]; a.async = 1; a.src = g; m.parentNode.insertBefore (a, m)}) (ventana, documento, 'script', 'https: //www.google-analytics.com/analytics .js ',' ga '); ga ('crear', 'UA-XXXXX-Y', 'auto'); ga ('enviar', 'página vista'); 

Dado que los scripts que se cargan desde diferentes dominios pueden crear cookies a las que XDK no puede acceder directamente debido a la misma política de origen en los navegadores, el XDK le permite crear scripts de limpieza que se pueden ejecutar para cada dominio.

En este caso el acción atributo de desarmado se puede usar para designar secuencias de comandos que limpian las cookies cuando los usuarios eliminan el consentimiento.

Ejemplo:

  
          
  

Recuerda:

NECESITARÁ UNA ABIERTA Y CERCA ETIQUETA INCLUSO CUANDO UTILICE SOLO EL ATRIBUTO SRC.

Referencia completa de parámetros

El XCK se inicializa con un conjunto de parámetros que determinan el comportamiento del XCK en su sitio. Esto puede incluir ubicación de representación, tiempos de espera, controladores de eventos, CSS, etc.

La siguiente es una lista de parámetros que XCK puede procesar:

checkByDefaultTypes formación

Esta es una serie de cadenas de tipos de cookies que se utilizan en sus sitios de forma predeterminada. Este es uno o más de [aplicación | uso | estadísticas | publicidad]. El valor predeterminado es una matriz vacía.

Ejemplo:

checkByDefaultTypes: ["aplicación"]

cookieHandler cuerda o función

Si está utilizando una aplicación de página única o una solución basada en JavaScript para configurar cookies, debe especificar una función de controlador de cookies, por ejemplo handleCookies ( ). El XCK llamará a esta función con las preferencias o valores predeterminados del usuario según sea necesario. Esta función debe eliminar o establecer las cookies en función de las categorías permitidas por el usuario.

Esto está relacionado con targetUrl. Uno de cookieHandler o targetUrl se requiere que se especifique para que XCK se inicie.

Ver más información en la sección Cómo usar el kit de cookies XcooBee en este documento

cookieHandler: handleCookies

displayOnlyForEU booleano

Esto le permite a XCK saber hacer una evaluación rápida del contexto de la llamada para XCK si los usuarios están fuera de la UE. Si el XCK determina que se está cargando fuera de la UE (28 bloque nacional) y no hay valores predeterminados del usuario u otra guía, el XCK puede aplicar automáticamente cookies estándar de la compañía utilizando el checkByDefaultTypes ajuste. Al hacerlo, informará al usuario pulsando rojo. El usuario visitante aún puede cambiar las decisiones en cualquier momento. El valor predeterminado es falso.

Tiempo de expiración entero

Este es el tiempo en segundos que mostraremos el icono de cookie flotante. Una vez alcanzado el tiempo de caducidad, el icono de cookie flotante se eliminará de la pantalla. Esta vez se restablece cada vez que se hace clic en el icono y se muestra un cuadro de diálogo emergente.

Cuando se establece en cero, el icono no se eliminará.

Por defecto es cero.

tiempo de expiración: 0

hideBrandTag booleano

Esto eliminará la etiqueta de marca con tecnología XcooBee. Aunque agradeceríamos que nuestro trabajo esté correctamente representado, entendemos que es necesario controlarlo. Si usted es una entidad comercial, lo alentamos a suscribirse a XcooBee para que podamos continuar apoyando proyectos de código abierto como este en el futuro. Predeterminado: falso

hideOnComplete: true

hideOnComplete booleano

El XCK se puede ocultar por completo una vez que el usuario ha realizado la selección del tipo de cookie o la selección se puede determinar automáticamente. Para habilitar la eliminación inmediata del icono de la cookie, establezca esto en verdadero. Predeterminado: falso

hideOnComplete: true

posición cuerda

El parámetro de posición es uno de [leftabajo | izquierdaarriba derechaabajo | derechaarriba] e indica la posición desde la cual XCK muestra su ventana o icono de cookie flotante. Predeterminado: left_bottom

posición: "left_bottom"

privacyUrl cuerda necesario

Esta es la página a la que se dirigirá al usuario para revisar su Política de privacidad. El kit de cookies no se iniciará sin datos para la Política de privacidad.

privacyUrl: "https://mysite.com/privacy"

requestDataTypes formación

Esta es una serie de cadenas de tipos de cookies utilizadas en sus sitios para las cuales desea obtener el consentimiento de los usuarios antes de crear. Este es uno o más de [aplicación | uso | estadísticas | publicidad]. El valor predeterminado es solicitud.

requestDataTypes: ["aplicación"]

targetUrl cuerda

Si está utilizando un sitio basado en la tecnología de Solicitud / Respuesta, por ejemplo PHP, JSP, CFML y configura las cookies en su código, el XCK realizará una llamada a través de HTTP POST al targetUrl que especifique y un parámetro de cuerpo con carga JSON con preferencias del usuario para las cookies.

Ejemplo de carga útil del cuerpo:

{"tiempo": "2018-10-11T15: 40: 28", "código": 200, "resultado": {"aplicación": verdadero, "uso": falso, "estadísticas": falso}}

Entonces, deberá configurar las cookies por tipo de cookie en consecuencia. Alentamos el uso de conexiones HTTPS / TLS para garantizar la seguridad adecuada.

Esto está relacionado con cookieHandler. Uno de cookieHandler o targetUrl se requiere que se especifique para que XCK se inicie.

Ver más información en la sección Cómo usar el kit de cookies XcooBee en este documento

targetUrl: "https://mysite.com/setCookies"

termsUrl cuerda necesario

Esta es la página a la que se dirigirá al usuario para que revise sus Términos de servicio. El kit de cookies no se iniciará sin los términos de servicio válidos.

termsUrl: "https://mysite.com/terms"

Modo de prueba booleano

El XCK puede ejecutarse en modo de prueba. Cuando lo haga, mostrará un pequeño Reiniciar botón debajo de la cookie principal flotante. Puede usarlo para borrar el almacén de datos local. Esto acelera las tareas de desarrollo ya que no necesita borrar datos manualmente ni abrir / cerrar ventanas privadas del navegador. Predeterminado: falso

testMode: verdadero

mensaje de texto cuerda necesario

Este es el mensaje que mostraremos al usuario cuando solicite las preferencias de cookies. Este mensaje puede formatearse como una cadena o como JSON. Al usar JSON, puede especificar el mensaje en diferentes idiomas. El XCK intentará determinar el idioma predeterminado en función de la configuración del navegador y recurrirá al inglés de EE. UU. Si no puede tomar una determinación. El kit de cookies no se iniciará sin un mensaje de consentimiento para mostrar a los usuarios.

Ejemplo de entrada de texto en un solo idioma:

textMessage: "Este sitio usa cookies. Seleccione los tipos de cookies que desea usar y luego haga clic en Aceptar"

Ejemplo de entrada de texto en varios idiomas:

{"en-us": "texto en inglés", "de-de": "texto en alemán", "es-419": "texto en español", "fr-fr": "texto en francés",}

Parámetros de inicialización con suscripción a XcooBee

CampañaReferencia

Esto conecta su campaignId a XCK. El asistente de campaña de XcooBee lo generará por usted.

El XCK puede mostrar el logotipo de su empresa. Las opciones de su campaña de cookies tendrán la capacidad de cargar un logotipo y estarán disponibles para XCK.
Este parámetro solo está disponible cuando se suscribe a XcooBee.

Anulación de CSS

Si desea utilizar su propio CSS, el generador de código XcooBee lo configurará en función de su selección para su Campaña de cookies. Su asistente de campaña lo guiará a través del proceso.

IMPORTANTE

El nombre de su campaña en la consola de la campaña XcooBee debe coincidir con su nombre de dominio (primera parte de la URL, p. Ej. https://mysite.com) para el que está utilizando el kit de cookies. Si este no es el caso, se le devolverán errores de la red XcooBee.

Por ejemplo, si su sitio se ejecuta en esta url "http://www.mysite.com/product/hello", el dominio es http://www.mysite.com. Este debe ser el nombre de su campaña en XcooBee.

Ganchos de programa

Puede usar métodos públicos de XCK para establecer y recuperar información de parámetros. Estos se encuentran debajo de XcooBee.kit objeto.

setManagedCookie ([categoría: cadena], [cookieName: cadena], [cookieValue: cadena], [días: entero])

Cree cookies totalmente compatibles con GDPR utilizando el setManagedCookie () método. Está descargando toda la interacción y la gestión del ciclo vital de la cookie a XCK. XCK se asegurará de que el usuario obtenga el consentimiento adecuado para la cookie antes de configurarla y también eliminará las cookies cuando el usuario elimine el consentimiento.
Este es el equivalente de JavaScript para usar el etiqueta en tu HTML. Será automáticamente compatible con todas las interacciones GDPR cuando use cookies administradas.

opciones:

  categoría => requerido: uno de: aplicación, uso, estadísticas, publicidad cookieName => requerido: nombre de su cookie cookieValue => require: el valor de su cookie días => opcional: días para persistir, el valor predeterminado es 0 = sesión

ejemplo:

XcooBee.kit.setManagedCookie ("uso", "myUserColor", "verde");

setParam ([parámetro: cadena], [valor: objeto])

Utilizar el setParam () Método para establecer cualquier parámetro válido para el XCK. Por ejemplo para configurar el targetUrl parámetro a un valor diferente. Dónde parámetro [cadena] es cualquiera de los parámetros válidos y valor [cualquiera] son datos para el parámetro.

XcooBee.kit.setParam ("targetUrl", "https://newsite.com/cookieProcessor");

Si estás usando un cookieHandler Función de JavaScript que no está expuesta en el ámbito global, deberá informar a XCK a través de un setParam llamada. Debe hacer esto después de cargar XCK pero antes de llamar XcooBee.kit.initialize ().

XcooBee.kit.setParam ("cookieHandler", myCookieHandlerFunction);

Alternativamente, puede inicializar con la referencia de función correcta.

<script>
  XcooBee.kit.initialize({
    requestDataTypes: ["application", "usage"],
    checkByDefaultTypes: ["application"],
    cookieHandler: myCookieHandlerFunction,
   ...
  });
</script>

Esto puede ser útil cuando desea desactivar ciertas funciones durante el tiempo de ejecución, por ejemplo, el hideOnComplete Param se puede utilizar para ocultar XCK después de que el usuario haya confirmado la selección de cookies.

getParam ([parámetro: cadena]) objeto

Recupera el valor del parámetro utilizado activamente de XCK.

Ejemplo:

let termsSite = XcooBee.kit.getParam ("termsUrl");

getConsentStatus () cuerda

Devuelve el estado actual de la interacción XCK con el usuario. Actual este es uno de [abierto | completo | cerrado].

abierto => al usuario se le solicita consentimiento en este momento

completar => hemos recibido información de consentimiento del usuario

cerrado => el usuario no respondió y el consentimiento de la cookie ha expirado después de Tiempo de expiración

let consentStatus = XcooBee.kit.getConsentStatus ();

getCookieTypes () objeto

Esto devuelve la decisión de los usuarios con respecto al consentimiento para cada tipo de cookie. Siempre devolverá un objeto completo con todos los tipos u objeto vacío {}.
Solo disponible después de getConsentStatus () = "completo" Si llama a esto antes de recibir una respuesta del usuario, le devolveremos un objeto vacío.

Llamada de ejemplo:

let cookieTypes = XcooBee.kit.getCookieTypes ();

Ejemplo de devolución de objeto:

{"aplicación": verdadero, "uso": verdadero, "estadísticas": falso, "publicidad": falso}

Ejemplos de etiqueta de script

Incrustará / instalará XCK a través de una etiqueta de script agregada a su sitio. Aquí hay un ejemplo de cómo podría ser esto.

Debe colocar esto en el HTML de su sitio entre y <body> Etiquetas Sugerimos esto como el último elemento del script.

<script id="xcoobee-cookie-kit" src="https://app.xcoobee.net/scripts/kit/xcoobee-cookie-kit.min.js"></script>
<script>
  XcooBee.kit.initialize({
    requestDataTypes: ["application", "usage"],
    checkByDefaultTypes: ["application"],
    cookieHandler: myCookieHandler,
    expirationTime: 0,
    position: "left_bottom",
    privacyUrl: "https://mysite.com/privacy",
    termsUrl: "https://mysite.com/terms",
    textMessage: "This site uses cookies to make your experience better. Please let us know which type of cookies we may use."
  });

</script>

Aquí hay un ejemplo de parámetros y tipos de valores para la inicialización:

<script id="xcoobee-cookie-kit" src="{URL}/scripts/kit/xcoobee-cookie-kit.min.js"></script>
<script>
  XcooBee.kit.initialize({
    campaignReference: <String>,
    checkByDefaultTypes: <Array>[application|usage|statistics|advertising]
    cookieHandler: <Function>,
    expirationTime: <Number> (in seconds),
    position: <String> ("left_bottom", "left_top", "right_bottom", "right_top"),
    privacyUrl: <String>,
    requestDataTypes: <Array>[application|usage|statistics|advertising],
    targetUrl: <String>,
    termsUrl: <String>,
    testMode: <Boolean>,
    textMessage: <String>, <Object>
  });

</script>

Referencia CSS

 Todos los elementos de visualización pueden anularse, sin embargo, no podemos admitir valores CSS no estándar.

Soporte de navegador

Internet Explorer 11+, Google Chrome, Mozilla Firefox, Opera, Edge.

Apoyo

Por favor use el Problemas de Github página

¿Te ayudó este artículo? si No

¿Cómo podemos ayudar?