1. Accueil
  2. Documents
  3. Documentation développeur
  4. Plugins / bibliothèques
  5. Kit de biscuits XcooBee

Kit de biscuits XcooBee

Télécharger et utiliser

Publié en Open Source sous licence Apache-2.0

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

Quelle est la différence

Le XCK est un cadre de gestion des cookies et du consentement actif pour votre site. Ceci est différent d'une zone de texte basée uniquement sur la notification des cookies.

Les notifications GDPR sur les cookies les plus courantes pour les sites Web ne sont que: des superpositions qui affichent des informations mais ne gèrent pas activement la création de cookies et les cycles de vie Vous êtes toujours responsable du traitement correct des cookies et des empreintes digitales. Contrairement à cela, le kit de cookies XcooBee est un véritable gestionnaire de consentement aux cookies et de cycle de vie. Il vous aidera à mettre en œuvre correctement les locaux du RGPD et de la directive européenne.

Exemple de démarrage rapide

  1. Chargez la bibliothèque à partir du CDN à l'aide de la balise de script:
<script id="xcoobee-cookie-kit" src="https://app.xcoobee.net/scripts/kit/xcoobee-cookie-kit.min.js"></script>
  1. Définissez vos cookies gérés avec balise dans votre DOM HTML comme ceci:
 abhchkshsdh  bleu foncé 
  1. Initialisez le kit Cookie pour gérer les choses à la fin du rendu de votre page:
<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>

Voir Référence des paramètres pour tout ce que vous pouvez faire.

Terminé !!

C'était un exemple super simple, le XCK prendra en charge les tâches liées au GDPR et à la directive électronique à partir d'ici. Bien sûr, il y a beaucoup plus d'exemples plus approfondis plus tard.

Vidéo

Tutoriel du kit de cookies

Qu'est-ce que le XCK

L'objectif du Kit de cookies XcooBee (XCK) est de permettre aux sites Web de gérer leur consentement aux cookies plus efficacement et avec moins d'agacement pour leurs utilisateurs. Le XCK peut travailler de concert avec le réseau XcooBee pour améliorer la gestion globale des utilisateurs et des entreprises, mais ce n'est pas obligatoire. Lorsque le XCK fonctionne indépendamment de XcooBee, certaines fonctionnalités de gestion ne sont pas disponibles.

Le XCK facilite l'ajout de la gestion du consentement aux cookies sur votre site Web. Il gère toutes les interactions des utilisateurs pour obtenir leur consentement et permet au site Web de savoir quels cookies peuvent être utilisés pour chaque utilisateur lors de leur visite sur votre site Web. De même, votre site Web peut désormais être informé lorsque les utilisateurs modifient leur consentement même lorsqu'ils ne le visitent pas.

Le XCK est l'un des moyens les plus transparents et sans friction pour gérer les cookies sur votre site. Il ne s'affichera pas, ne gênera pas ou ne gênera pas l'expérience de l'utilisateur lorsqu'il n'est pas nécessaire. Pourtant, en même temps, il assure la conformité avec les directives électroniques européennes et les règles connexes du RGPD.

Les propriétaires de sites Web peuvent facilement réagir aux demandes de données et signaler les demandes liées à la confidentialité si nécessaire via le réseau XcooBee.

Le XCK ne nécessite pas de connexion XcooBee pour fonctionner sur votre site Web. Vous aurez toujours accès à la majorité de la collecte de consentement des utilisateurs, mais vous n'aurez pas de gestion centralisée des informations et des consentements.

Le XCK est réactif et s'adaptera facilement à différents écrans, y compris les utilisations mobiles.

Démarrage rapide pour se rendre à exemples de balises.

Caractéristiques

Avec le kit de cookies, vous pouvez:

  • utiliser la pré-classification XcooBee des cookies pour présenter des détails simplifiés et clairs sur la façon dont vous utiliserez les cookies
  • partagez vos politiques de cookies
  • partagez vos conditions de service
  • partagez votre politique de confidentialité
  • déterminer les interactions de définition / de désactivation des cookies
  • intégrer avec les services backend pour les notifications de cookies
  • déterminer de manière transparente si une notification est nécessaire
  • permettre aux utilisateurs de supprimer / ajouter le consentement pour les cookies
  • définir le moment et la position de l'affichage des informations
  • réagir correctement aux autorisations de consentement des utilisateurs et aux demandes de suppression

Avec l'abonnement à XcooBee, vous pouvez également:

  • documenter vos interactions de consentement de cookie
  • gérer à distance le consentement de l'utilisateur
  • documenter le temps de réponse approprié aux demandes des utilisateurs
  • définir des éléments de style et de logo supplémentaires
  • permet aux utilisateurs d'utiliser l'intelligence de cookie de foule

Classification facile des cookies

Le XCK utilise un système de classification des cookies plutôt que de répertorier chaque cookie individuel avec son origine. En plaçant les cookies dans des groupes logiques, le XCK supprime le besoin d'expertise technique pour distinguer les cookies individuels. Les utilisateurs peuvent prendre une décision plus facile en fonction de l'utilisation prévue du cookie plutôt que du nom de domaine ou de tout autre critère technique.

Le système de classification XcooBee place largement les cookies dans l'un des types suivants:

  • Cookies requis ou d'application
  • Cookies de personnalisation
  • Cookies statistiques
  • Cookies publicitaires et marketing

Pour plus d'informations, s'il vous plaît visitez Classification des cookies XcooBee.

Exemples d'applications

Nous avons inclus trois exemples d'applications qui utilisent le XCK pour que vous puissiez le voir vous-même en action.

Application d'une seule page

Notre application de café montre l'utilisation de XCK dans une application d'une seule page. Vous pouvez décompresser et déployer sur un serveur Web comme IIS ou Apache. Les fichiers se trouvent dans examples / cafe-spa.zip. Revoir le index.html fichier pour les instructions / explications.

Cookie Kit Simple HTML App

Exemple d'application de demande / réponse basée sur NodeJs & Express

Notre application de pizza démontre l'utilisation du XCK dans une application basée sur demande / réponse. Vous pouvez décompresser et le déployer directement sur votre système. Vous aurez besoin de nodejs installé sur votre système pour certains. Revoir le README.md fichier pour des instructions / explications dans chacun des exemples d'application Single Page (SPA), Express et ReactJS:

Exemple d'application de kit de cookies

Exemple d'application basée sur ReactJS

Un clone de notre application de café pour démontrer l'utilisation du XCK avec React. Nous utilisons pour cela la React Build spéciale du XCK et vous devriez revoir le kit de cookies réactifs sur npm js.

Exemple de kit de cookies React Application

Comment cela marche-t-il

Le cookie

the cookie

Le XCK affiche une icône de cookie flottante à l'écran dans un coin de votre choix. Il s'agit du point de départ de l'interaction utilisateur. En cliquant sur l'icône de cookie, les utilisateurs ouvrent une boîte de dialogue de consentement contextuelle qui leur permet d'interagir avec votre site.

Si le XCK détermine qu'un consentement de l'utilisateur est nécessaire, il passera à l'étape suivante et ouvrira la boîte de dialogue contextuelle XCK:

La boîte de dialogue contextuelle

showing XCK cookie popup

Le XCK peut déterminer automatiquement quand une boîte de dialogue de consentement complet ou simplement le cookie est nécessaire. Ainsi, rendre la visite du site plus agréable et sans friction.

Lorsque vous utilisez le XCK, vous:

  • a) déterminer d'abord quels cookies vous utilisez actuellement sur votre site
  • b) puis sélectionnez le type de cookie XcooBee (classification) qui correspond le mieux à chaque cookie
  • c) afficher aux visiteurs de votre site la boîte de dialogue de consentement XCK pour demander la permission
  • d) après avoir obtenu le consentement pour un type de cookie, définissez les cookies dans ce groupe pour votre utilisateur en utilisant soit un gestionnaire dans le client JavaScript ou un modèle d'URL cible via la syntaxe du serveur (PHP, JSP, .net etc.) ou les deux.

Si le consentement des cookies est déjà obtenu, le XCK n'affichera pas d'autre popup. Vous pouvez interroger l'état via JavaScript pour définir à nouveau les cookies, ou suivre cela du côté backend si vous utilisez une application de type demande / réponse.

Exemple de parcours

Supposons un exemple de site de shopping géré par JSP qui utilise quatre cookies. Voici un exemple de processus pour implémenter une gestion appropriée du consentement des cookies à l'aide du XCK:

une Vous déterminez que vous utilisez les quatre cookies suivants sur votre site.

  1. Votre cookie de session JSP
  2. Un cookie utilisateur pour garder une trace du thème de l'utilisateur
  3. Un cookie de statistiques de site de votre serveur Web
  4. Un cookie de statistiques globales de Google Analytics

b Vous classifiez les cookies dans les types suivants

Application: cookie de session JSP

Personnalisation: cookie utilisateur

Statistiques: cookie de serveur Web local et cookie Google Analytics

c Vous initialiser et rendre le script XCK pour afficher la fenêtre contextuelle de consentement de l'utilisateur.

L'utilisateur fait une sélection et clique sur OK.

e Le XCK invoque le processus du gestionnaire JavaScript de votre site qui définit ou supprime les cookies.

Cookie Pulses

Le kit de cookies utilise une méthode d'évaluation de raccourci pour vérifier s'il a déjà obtenu le consentement de l'utilisateur pour les cookies. Cela rationalise la configuration des cookies. Lorsque cela réussit, l'icône de cookie placée dans un coin désigné est remplacée par des impulsions. Il existe différentes impulsions de couleur pour indiquer qu'une sélection de raccourcis s'est produite.

Vert: approbation explicite de l'utilisateur

green cookie pulse

L'impulsion verte indique que l'utilisateur a déjà visité ce site et que les paramètres de consentement aux cookies du site sont connus et peuvent être réappliqués.

Bleu: approbation basée sur les préférences

blue cookie pulse

L'impulsion bleue indique que bien que l'utilisateur n'ait pas visité ce site auparavant, l'utilisateur a défini des préférences de consentement pour de nouveaux sites qui peuvent être appliqués. Cela n'est possible que lorsque l'utilisateur et le site Web sont membres du réseau XcooBee.

Jaune: approbation basée sur l'intelligence des foules

yellow cookie pulse

Le pouls jaune indique que l'utilisateur a choisi de participer au programme XcooBee Crowd AI pour les cookies. Le réseau XcooBee utilisera une analyse basée sur la foule et définira les cookies en fonction des commentaires des visiteurs du site Web. Cela n'est possible que lorsque l'utilisateur et le site Web sont membres du réseau XcooBee.

Rouge: utilisation des préférences du site Web

red cookie pulse

L'impulsion rouge indique que nous n'avons aucune information directement de l'utilisateur. Dans un tel cas, le propriétaire du site Web peut choisir d'utiliser la préférence du site Web pour les cookies au lieu des préférences de l'utilisateur. Cela ne peut être fait que si le site Web et l'utilisateur sont situés en dehors de l'UE.

Installer

Vous activez le XCK en l'intégrant à votre site via Mots clés. De plus, lors de l'appel, vous fournissez des paramètres supplémentaires à la balise de script.

Certains d'entre eux comprennent:

  • position du bouton icône
  • URL des termes
  • URL de la politique des cookies
  • heure d'expiration du widget
  • message texte
  • fonction de gestion des cookies
  • valeurs par défaut du site
  • Cible URL

Lorsque vous vous abonnez à XcooBee, vous pouvez également spécifier:

  • la référence de votre campagne
  • logo d'entreprise
  • cssAutoLoad

UNE campaignId est nécessaire pour que le XCK communique avec XcooBee et permette la gestion des consentements. Veuillez visiter XcooBee si vous devez créer un compte. Sans cela, le XCK fonctionnera en mode hors ligne.

Modes de fonctionnement

Le XCK fonctionne en deux modes. Un, en mode déconnecté, où le XCK et votre site Web interagissent directement sans utiliser le réseau XcooBee. Deuxièmement, en mode connecté, où XCK interagit avec le réseau XcooBee pour permettre aux entreprises de documenter et de gérer le consentement aux cookies tout en offrant aux utilisateurs des outils supplémentaires pour gérer et simplifier la gestion des cookies.

Dans ce qui suit, nous expliquons le fonctionnement de chaque mode.

Mode déconnecté

diagram showing XCK in disconnected mode

En mode déconnecté,

  1. votre site Web se charge et rend son contenu sans paramétrer les cookies
  2. charge le XCK avec vos paramètres
  3. le XCK gère l'interaction de l'utilisateur pour le consentement des cookies
  4. communique à votre site quels types de cookies peuvent être définis.

Votre site définit donc les cookies en fonction des préférences de l'utilisateur.

Mode connecté

alt text

Le mode connecté est similaire dans le processus avec des différences à chaque étape pour refléter des outils supplémentaires:

En mode connecté,

  1. votre site Web se charge et rend son contenu sans paramétrer les cookies
  2. charge le XCK avec vos paramètres, y compris les références de votre campagne
  3. le XCK gère l'interaction de l'utilisateur pour le consentement des cookies. Pour les utilisateurs de XcooBee, le XCK négocie de manière transparente avec votre site en fonction des préférences de l'utilisateur. Les utilisateurs de XcooBee peuvent surfer sur des sites sans interruption.
  4. XCK communique à votre site quels types de cookies peuvent être définis.Votre site, puis définit les cookies en fonction des préférences de l'utilisateur.
  5. En tant que propriétaire du site, vous pouvez consulter tous les consentements aux cookies gérés. Signalez les problèmes de conformité, prenez des mesures lorsque les utilisateurs modifient leur consentement même lorsqu'ils ne visitent pas votre site. Les visiteurs de votre site (utilisateurs) peuvent gérer activement le consentement des cookies de manière centralisée et surfer de manière transparente sur votre site sans popups ennuyeux.

Comment utiliser le kit de cookies XcooBee

Cette section explique comment utiliser le XCK sur votre site.

Comment utiliser le Kit de cookies dans une application à page unique (SPA)

Lorsque vous utilisez un SPA, vous pouvez spécifier un gestionnaire JavaScript qui peut recevoir le résultat de l'interaction de l'utilisateur pour le consentement des cookies. Par la suite, vous devez charger les scripts et / ou définir les cookies directement en fonction de l'interaction de l'utilisateur.

Comme cela peut changer, vous devez également pouvoir supprimer les cookies lorsque les utilisateurs changent d'avis.

Dans les deux cas, le XCK invoquera votre fonction de gestionnaire une fois que l'utilisateur aura terminé son interaction avec XCK.

XCK appellera votre gestionnaire JavaScript avec un objet JavaScript. Les préférences de l'utilisateur sont énumérées dans l'argument.

Tu peux trouver un exemple de SPA sur github.

Voici et exemple d'objet.

{"application": vrai, "usage": vrai, "statistiques": faux, "publicité": faux}

Ainsi, la signature de l'appel sera: handlerFunction (cookieObject).

Par exemple, si votre fonction de gestionnaire est nommée cookieHandler et l'objet d'argument de fonction est nommé userCookiePreferences ce serait la signature de votre fonction:

cookieHandler (userCookiePreferences);

Exemple de fonction cookieHandler:

function cookieHandler (consentSettings) {if (consentSettings.application) {// définir les cookies requis ici // ...} else {// supprimer le cookie requis ici // ...}; if (consentSettings.usage) {// définir les cookies de personnalisation de l'utilisateur ici // ...} else {// supprimer les cookies de personnalisation de l'utilisateur ici // ...}; if (consentSettings.statistics) {// définir les statistiques du site collectant les cookies ici // ...} else {// supprimer les statistiques du site collectant les cookies ici // ...}; if (consentSettings.advertising) {// définir les cookies de publicité et de marketing et de suivi ici // ...} else {// supprimer les cookies de publicité et de marketing et de suivi ici // ...}; }

Voir plus exemple entièrement développé plus loin dans ce document.

Comment utiliser Cookie Kit avec des systèmes de demande / réponse comme PHP, Node, JSP, .net, CFML, etc.

Le XCK peut également communiquer l'octroi et la suppression du consentement des utilisateurs pour les cookies à votre site via la publication de webhook (HTTP POST). Vous aurez besoin d'un point de terminaison accessible sur le Web tel que défini par Cible URL qui peut traiter ces messages et définir / désactiver les cookies par type de cookie.

Cependant, selon votre situation, vous pourrez toujours gérer toutes les interactions à l'intérieur de JavaScript sans rechargements ni appels au backend (voir l'exemple ci-dessous)

Le HTTP POST utilisera TYPE DE CONTENU = application / json

Le contenu du corps est un objet JSON avec la sélection de types de cookies par l'utilisateur. Seuls les types de cookies pour lesquels vous avez demandé votre consentement seront inclus.

{"time": "2018-10-31T16: 40: 28", "code": 200, "result": {"application": true, "usage": false, "statistics": true}}

Où:

heure => date de la décision en code UTC => 200 pour un résultat réussi => le JSON avec des informations sur les types de cookies

Un exemple de processus pour gérer le consentement des cookies via une demande / réponse et un page-gestionnaire modèle pourrait ressembler à ceci. Votre page-gestionnaire est très probablement un morceau de code qui devra être inclus dans tous les appels de rendu de page. Vous devrez également pouvoir l'appeler indépendamment.

  1. Votre système démarre sans aucun cookie
  2. Si aucun cookie n'est défini, vous invoquez le XCK
  3. Le XCK recueille le consentement de l'utilisateur et appelle le page-gestionnaire identifié dans Cible URL paramètre
  4. page-gestionnaire enregistre la décision de l'utilisateur et signale que l'utilisateur a pris la décision
  5. pour chaque appel ultérieur, le page-gestionnaire vérifie que la décision de l'utilisateur est disponible et définit les types de cookies

Votre page-gestionnaire emploiera probablement ce genre de logique

  • déterminer s'il s'agit d'un appel régulier (inclus) ou d'un appel de XCK pour enregistrer la décision de l'utilisateur
  • si appel régulier
    • déterminer si nous avons une décision concernant le type de cookie utilisateur
    • si nous n'avons pas de décision -> charger XCK en insérant balises en HTML pour présenter le choix des cookies à l'utilisateur
    • si nous avons une décision de cookie d'utilisateur -> charger des cookies pour chaque type autorisé
  • si appelé de XCK
    • enregistrer la décision de cookie d'utilisateur

    Vous pouvez également consulter notre exemple d'application Express / NodeJs sur Github.

Exemple d'utilisation avec une page PHP combinée avec Cookie Kit

Dans cet exemple, nous supposons que nous avons un site Web exécutant un moteur PHP pour rendre les pages Web. Dans le cadre de ce processus, le site Web chargera le XCK pour gérer le consentement de l'utilisateur. Vous gérez la création de cookies via JavaScript.

Le processus de gestion se décompose en ce flux:

une. La page PHP écrit les valeurs de chacun des types de cookies dans un flux HTML / Javascript

b. Inclure le code du gestionnaire JS (exemple ci-dessous)

c. Charger XCK

une Canalisez des variables PHP avec des balises de script en HTML

Dans cet exemple, nous supposons que vous avez JS balises pour tous les cookies dont vous avez besoin pour créer et les enregistrer dans les variables PHP correspondantes de cette manière:

$cookie_scripts_application => les cookies d'application requis, par exemple par exemple:  $cookie_scripts_user => les cookies de personnalisation de l'utilisateur par exemple:  $cookie_scripts_statistics => les cookies de statistiques du site par exemple:  $cookie_scripts_advertising => les cookies publicitaires du site par exemple: 

Vous devez produire chacun de ces codes HTML en les encodant, comme ceci

<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>

b écrire un gestionnaire JS

Vous devez définir votre gestionnaire dans JS. Nous incluons quelques fonctions d'assistance qui définiront réellement vos cookies et chargeront vos 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 Charger le kit de cookies XcooBee

Comme indiqué dans quelques domaines, lorsque vous souhaitez démarrer la boîte de dialogue XCK, incluez le balises dans votre flux 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>

Comment utiliser le XCK avec l'abonnement XcooBee et l'échange de données haute sécurité

Lorsque vous avez un abonnement XcooBee, votre site Web peut également recevoir des mises à jour concernant le consentement accordé lorsque l'utilisateur n'est pas directement en ligne via le réseau XcooBee. Cette communication se fera via des webhooks et un niveau de cryptage supérieur.

Comme alternative au HTTP POST direct, votre abonnement au réseau XcooBee permet également l'interrogation des événements afin que vous puissiez utiliser le XCK pour les sites qui ne sont pas directement accessibles via Internet, c'est-à-dire les sites intranet ou les sites en développement.

Vous devez être en mesure de traiter les messages de XcooBee qui utilisent le cryptage PGP en plus de HTTPS / TLS.
Le modèle de message est le même que celui décrit dans la section précédente.

Vous pouvez utiliser l'un des SDK XcooBee pour simplifier cette interaction:

L'utilisation du réseau XcooBee n'est pas une interaction requise. Les utilisateurs mettront à jour de manière transparente leurs préférences en matière de cookies avec votre site chaque fois qu'ils visitent.

Cookies et scripts gérés

La plupart des notifications de cookies n'implémentent pas la gestion du cycle de vie et si vous, en tant que programmeur, n'implémentez pas le comportement correct pour les événements d'interaction avec l'utilisateur, vous échouerez toujours à votre audit RGPD et votre entreprise pourrait devenir responsable des manquements à la conformité. Le XCK vous offre une alternative très simple qui vous permet de rester facilement conforme.

L'utilisation de cookies et de scripts gérés est le moyen le plus simple de déclarer et de gérer les cookies avec le XCK. Cette approche permet au XCK de gérer le cycle de vie de vos cookies de la création à la destruction. Il ne nécessite que des changements d'application minimes. Tant que votre application peut écrire une balise HTML, vous pouvez créer des cookies et des scripts gérés.

Les fonctionnalités sont implémentées via deux extensions de balises HTML supplémentaires que vous pouvez utiliser:

Vous avez besoin à la fois d'une balise d'ouverture et d'une fermeture.
Vous devez déclarer toutes vos balises avant d'appeler le XCK initialiser() une fonction.

balise xbee-cookie

le La balise vous permet de déclarer un cookie géré unique.

Il s'agit d'une déclaration pour les cookies que vous pouvez ajouter n'importe où dans le DOM HTML où vous souhaitez placer des cookies.
Le XCK gère automatiquement le cycle de vie, y compris le retrait.
Si les balises possibles doivent être écrites sur une seule ligne:

supercookievalue

La valeur du cookie se situe entre les balises d'ouverture et de fermeture (innerHTML).

Les attributs:

  nom => le nom du cookie que vous souhaitez définir catégorie => l'une des catégories de cookies: application, utilisation, statistiques, jours de publicité => facultatif: le nombre de jours pour définir le cookie, s'il n'est pas fourni, expirera avec la session

Exemples:

 c'est une valeur du cookie  grand cookie 

balise xbee-script

Si vous définissez des cookies via des scripts distants ou devez charger des scripts tiers qui définissent certains cookies, la manière la plus simple de les gérer consiste à utiliser le étiquette.

La balise xbee-script fonctionne comme la balise de script HTML mais possède deux attributs supplémentaires. Cela vous permet de convertir facilement balises dans Mots clés.

Le contenu de la balise est Javascript qui sera exécuté plus tard après avoir obtenu le consentement des utilisateurs. Vous pouvez également spécifier des scripts distants via src attribuer comme d'habitude. Vous devrez ajouter une balise de fermeture sous forme de fermeture automatique sur une seule ligne n'est pas autorisé:

utilisez plutôt ceci

Attributs supplémentaires:

  action => l'une des "set" ou "unset", vous pouvez fournir des scripts de nettoyage avec la catégorie d'attribut "unset" => l'une des catégories de cookies: application, utilisation, statistiques, publicité

Exemple:

   (fonction (i, s, o, g, r, a, m) {i ['GoogleAnalyticsObject'] = r; i [r] = i [r] || function () {(i [r] .q = i [r] .q || []). push (arguments)}, i [r] .l = 1 * new Date (); a = s.createElement (o), m = s.getElementsByTagName (o) [ 0]; a.async = 1; a.src = g; m.parentNode.insertBefore (a, m)}) (fenêtre, document, 'script', 'https: //www.google-analytics.com/analytics .js ',' ga '); ga ('créer', 'UA-XXXXX-Y', 'auto'); ga ('envoyer', 'page vue'); 

Étant donné que les scripts chargés à partir de différents domaines peuvent créer des cookies qui ne sont pas directement accessibles par XDK en raison de la même politique d'origine dans les navigateurs, le XDK vous permet de créer des scripts de nettoyage qui peuvent être exécutés pour chaque domaine.

Dans ce cas, le action attribut de désarmé peut être utilisé pour désigner des scripts qui nettoient les cookies lorsque les utilisateurs retirent leur consentement.

Exemple:

  
          
  

Rappelles toi:

VOUS AUREZ BESOIN D'UN OUVERT ET FERMER TAG MÊME LORSQUE VOUS N'UTILISEZ QUE SRC ATTRIBUTE.

Référence complète des paramètres

Le XCK est initialisé avec un ensemble de paramètres qui déterminent le comportement du XCK sur votre site. Cela peut inclure l'emplacement de rendu, les délais d'expiration, les gestionnaires d'événements, les CSS, etc.

Voici une liste de paramètres que le XCK peut traiter:

checkByDefaultTypes tableau

Il s'agit d'un tableau de chaînes de types de cookies utilisés par défaut sur vos sites. Il s'agit d'une ou de plusieurs [application | utilisation | statistiques | publicité]. La valeur par défaut est un tableau vide.

Exemple:

checkByDefaultTypes: ["application"]

cookieHandler chaîne ou une fonction

Si vous utilisez une application d'une seule page ou une solution basée sur JavaScript pour configurer les cookies, vous devez spécifier une fonction de gestion des cookies, par exemple handleCookies ( ). Le XCK appellera cette fonction avec les préférences ou les valeurs par défaut de l'utilisateur selon les besoins. Cette fonction doit supprimer ou définir les cookies en fonction des catégories autorisées par l'utilisateur.

Ceci est lié à Cible URL. Un des cookieHandler ou Cible URL doit être spécifié pour que XCK démarre.

Voir plus d'informations dans la section Comment utiliser le kit de cookies XcooBee dans ce document.

cookieHandler: handleCookies

displayOnlyForEU booléen

Cela permet au XCK de savoir faire une évaluation rapide du contexte d'appel pour le XCK si les utilisateurs sont en dehors de l'UE. Si le XCK détermine qu'il est en cours de chargement en dehors de l'UE (bloc de 28 pays) et qu'il n'y a pas de valeurs par défaut de l'utilisateur ou d'autres instructions, le XCK peut automatiquement appliquer les cookies standard de l'entreprise en utilisant le checkByDefaultTypes réglage. Ce faisant, il en informe l'utilisateur en pulsant en rouge. L'utilisateur visiteur peut toujours modifier les décisions à tout moment. La valeur par défaut est: false.

date d'expiration entier

C'est le temps en secondes où nous afficherons l'icône de cookie flottant. Une fois le délai d'expiration atteint, l'icône de cookie flottant sera supprimée de l'affichage. Cette heure est réinitialisée à chaque fois que vous cliquez sur l'icône et qu'une boîte de dialogue contextuelle s'affiche.

Lorsqu'il est réglé sur zéro, l'icône ne sera pas supprimée.

Par défaut à zéro.

expirationTime: 0

hideBrandTag booléen

Cela supprimera l'étiquette de la marque powered by XcooBee. Bien que nous apprécierions que notre travail soit correctement représenté, nous comprenons qu'il est nécessaire de contrôler cela. Si vous êtes une entité commerciale, nous vous encourageons à vous abonner à XcooBee afin que nous puissions continuer à soutenir des projets open source comme celui-ci à l'avenir. Par défaut: faux

hideOnComplete: true

hideOnComplete booléen

Le XCK peut être complètement masqué une fois que l'utilisateur a effectué la sélection du type de cookie ou que la sélection peut être déterminée automatiquement. Pour activer la suppression immédiate de l'icône de cookie, définissez cette valeur sur true. Par défaut: faux

hideOnComplete: true

position chaîne

Le paramètre de position est l'un de [gaucheen bas à gaucheen haut à droiteen bas à droitehaut] et indique la position à partir de laquelle le XCK affiche sa fenêtre ou son icône de cookie flottant. Par défaut: left_bottom

position: "left_bottom"

privacyUrl chaîne obligatoire

Il s'agit de la page vers laquelle l'utilisateur sera invité à consulter votre politique de confidentialité. Le kit de cookies ne démarrera pas sans les données de la politique de confidentialité.

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

requestDataTypes tableau

Il s'agit d'un ensemble de chaînes de types de cookies utilisés sur vos sites pour lesquels vous souhaitez obtenir le consentement des utilisateurs avant de créer. Il s'agit d'une ou de plusieurs [application | utilisation | statistiques | publicité]. La valeur par défaut est application.

requestDataTypes: ["application"]

Cible URL chaîne

Si vous utilisez un site basé sur la technologie Request / Response, par exemple PHP, JSP, CFML et que vous définissez les cookies dans votre code, le XCK fera un appel via HTTP POST à la targetUrl que vous spécifiez et un paramètre de corps avec la charge utile JSON avec le les préférences de l'utilisateur pour les cookies.

Exemple de charge utile corporelle:

{"time": "2018-10-11T15: 40: 28", "code": 200, "result": {"application": true, "usage": false, "statistics": false}}

Vous devrez alors définir les cookies par type de cookie en conséquence. Nous encourageons l'utilisation de connexions HTTPS / TLS pour assurer une sécurité appropriée.

Ceci est lié à cookieHandler. Un des cookieHandler ou Cible URL doit être spécifié pour que XCK démarre.

Voir plus d'informations dans la section Comment utiliser le kit de cookies XcooBee dans ce document.

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

termsUrl chaîne obligatoire

Il s'agit de la page vers laquelle l'utilisateur sera invité à consulter vos conditions d'utilisation. Le kit de cookies ne démarrera pas sans conditions de service valides.

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

mode d'essai booléen

Le XCK peut fonctionner en mode test. Quand il le fait, il affichera un petit réinitialiser sous le cookie flottant principal. Vous pouvez l'utiliser pour effacer le magasin de données local. Cela accélère les tâches de développement car vous n'avez pas besoin d'effacer les données manuellement ou d'ouvrir / fermer les fenêtres de navigateur privées. Par défaut: faux

testMode: true

message texte chaîne obligatoire

C'est le message que nous afficherons à l'utilisateur lors de la demande de préférences de cookies. Ce message peut être formaté en chaîne ou en JSON. Lorsque vous utilisez JSON, vous pouvez spécifier le message dans différentes langues. Le XCK tentera de déterminer la langue par défaut en fonction des paramètres du navigateur et se repliera sur l'anglais américain s'il ne peut pas faire de détermination. Le kit de cookies ne démarrera pas sans un message de consentement à afficher aux utilisateurs.

Exemple de saisie de texte en une seule langue:

textMessage: "Ce site utilise des cookies. Veuillez sélectionner les types de cookies que vous souhaitez utiliser, puis cliquez sur OK"

Exemple de saisie de texte en plusieurs langues:

{"en-us": "Texte anglais", "de-de": "Texte allemand", "es-419": "Texte espagnol", "fr-fr": "Texte français",}

Paramètres d'initialisation avec l'abonnement XcooBee

campaignReference

Cela connecte votre campaignId au XCK. L'assistant de campagne XcooBee le générera pour vous.

Le XCK peut afficher le logo de votre entreprise. Vos options de campagne de cookies auront la possibilité de télécharger un logo et seront mises à la disposition du XCK.
Ce paramètre n'est disponible que lors de la souscription à XcooBee.

Remplacement CSS

Si vous souhaitez utiliser votre propre CSS, le générateur de code XcooBee le définira en fonction de votre sélection pour votre campagne de cookies. Votre assistant de campagne vous guidera tout au long du processus.

IMPORTANT

Le nom de votre campagne dans la console de campagne XcooBee doit correspondre à votre nom de domaine (première partie de l'URL, par exemple https://mysite.com) pour lequel vous utilisez le kit de cookies. Si ce n'est pas le cas, des erreurs seront renvoyées par le réseau XcooBee.

Par exemple, si votre site fonctionne sur cette URL "http://www.mysite.com/product/hello", le domaine est http://www.mysite.com. Ce doit être le nom de votre campagne dans XcooBee.

Crochets de programme

Vous pouvez utiliser des méthodes publiques du XCK pour définir et récupérer des informations sur les paramètres. Ceux-ci se trouvent sous le XcooBee.kit objet.

setManagedCookie ([catégorie: chaîne], [cookieName: chaîne], [cookieValue: chaîne], [jours: entier])

Créez des cookies entièrement conformes au RGPD en utilisant le setManagedCookie () méthode. Vous déchargez toutes les interactions et la gestion du cycle de vie du cookie sur le XCK. Le XCK s'assurera que l'utilisateur obtient le consentement approprié pour le cookie avant de le configurer et supprimera également les cookies lorsque l'utilisateur retire son consentement.
Il s'agit de l'équivalent JavaScript de l'utilisation du balise dans votre code HTML. Vous serez automatiquement conforme à toutes les interactions GDPR lors de l'utilisation de cookies gérés.

options:

  catégorie => obligatoire: l'un des: application, utilisation, statistiques, publicité cookieName => obligatoire: nom de votre cookie cookieValue => obligatoire: la valeur de votre cookie jours = = facultatif: jours pour périr, la valeur par défaut est 0 = session

exemple:

XcooBee.kit.setManagedCookie ("utilisation", "myUserColor", "green");

setParam ([paramètre: chaîne], [valeur: objet])

Utilisez le setParam () pour définir tout paramètre valide pour le XCK. Par exemple, pour définir Cible URL paramètre à une valeur différente. Où paramètre [chaîne] est l'un des paramètres valides, et valeur [tout] correspond aux données du paramètre.

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

Si vous utilisez un cookieHandler Fonction JavaScript qui n'est pas exposée dans la portée globale, vous devrez en informer le XCK via un setParam appel. Vous devez le faire après avoir chargé le XCK mais avant d'appeler XcooBee.kit.initialize ().

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

Alternativement, vous pouvez initialiser avec une référence de fonction correcte.

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

Cela peut être utile lorsque vous souhaitez désactiver certaines fonctions pendant l'exécution, par exemple le hideOnComplete param peut être utilisé pour masquer le XCK après que l'utilisateur a confirmé la sélection des cookies.

getParam ([paramètre: chaîne]) objet

Récupère la valeur du paramètre activement utilisé dans le XCK.

Exemple:

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

getConsentStatus () chaîne

Renvoie l'état actuel de l'interaction XCK avec l'utilisateur. Actuellement, il s'agit de l'un de [ouvert | complet | fermé].

ouvert => l'utilisateur est sollicité pour le moment

Achevée => nous avons reçu des informations de consentement de l'utilisateur

fermé => l'utilisateur n'a pas répondu et le consentement du cookie a expiré après date d'expiration

laissez consentStatus = XcooBee.kit.getConsentStatus ();

getCookieTypes () objet

Cela renvoie la décision des utilisateurs concernant le consentement pour chaque type de cookie. Il retournera toujours un objet complet avec tous les types ou un objet vide {}.
Disponible uniquement après getConsentStatus () = "complete" Si vous appelez cela avant que nous ayons une réponse de l'utilisateur, nous retournerons un objet vide.

Exemple d'appel:

laissez cookieTypes = XcooBee.kit.getCookieTypes ();

Exemple d'objet de retour:

{"application": vrai, "usage": vrai, "statistiques": faux, "publicité": faux}

Exemples de balise de script

Vous allez intégrer / installer le XCK via l'ajout d'une balise de script à votre site. Voici un exemple de ce à quoi cela pourrait ressembler.

Vous devez placer ceci dans le HTML de votre site entre et <body> Mots clés. Nous suggérons cela comme dernier élément de 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>

Voici un exemple de paramètres et de types de valeurs pour l'initialisation:

<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>

Référence CSS

 Tous les éléments d'affichage peuvent être remplacés, cependant, nous ne pouvons pas prendre en charge les valeurs CSS non standard.

Prise en charge du navigateur

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

Soutien

Veuillez utiliser le Problèmes avec Github page

Cet article vous a-t-il été utile ? Oui Non

Comment pouvons-nous aider ?