Iubenda logo
Crie Agora

Documentação

Tabela de conteúdos

Cookie Solution – guia de instalação do plugin PrestaShop

O plugin PrestaShop da iubenda permite automatizar a implementação das regras da Lei dos Cookies, reduzindo significativamente a necessidade de intervenções diretas no código do site.

Atenção
  • O módulo é atualmente compatível com todas as versões do Prestashop, a partir da 1.7
  • Você também precisa ter as substituições ativadas (ativadas por padrão)
Cookie Solution do iubenda para o PrestaShop

Funcionalidade

  • O plugin adiciona automaticamente o código do iubenda a todas as páginas do site (na seção HEAD);
  • Gerencia a visualização do banner e da política de cookies, além de salvar as preferências de consentimento do usuário de acordo com a instalação do cookie;
  • Ele auxilia a atribuição automática de categorias ao bloquear scripts;
  • Simplifica a gestão da Cookie Solution do iubenda para sites multilingues.
  • AdRoll
  • AddThis widgets
  • Bing
  • CodePen
  • Criteo
  • Disqus
  • Elevio
  • Facebook Comments
  • Facebook widgets
  • Freshchat
  • Google AdSense
  • Google Analytics
  • Google Maps
  • Google ReCaptcha
  • Google Site Search
  • Google Tag Manager
  • Google oAuth
  • Google+ widgets
  • Headway
  • Instagram widgets
  • Kissmetrics
  • LinkedIn widgets
  • Mixpanel
  • Neodata
  • Olark
  • Optimizely
  • Outbrain
  • PayPal widgets
  • Pingdom
  • Pinterest widgets
  • Segment
  • ShareThis widgets
  • Twitter widgets
  • UserVoice
  • Vimeo
  • YouTube

Instruções

Instalação e ativação

  • Faça login e abra a seção do administrador para acessar o painel principal do PrestaShop;
  • Clique em Modules > Modules & Services no menu da barra lateral;
  • Clique em Upload a module na seção do cabeçalho;
  • Para instalar o módulo, carregue o arquivo zip (clique aqui para baixar) – você deve clicar no arquivo zip do módulo, e não em sua pasta ou qualquer de seus arquivos descompactados.

Se a instalação for bem-sucedida, você receberá esta mensagem:

Plugin PrestaShop do iubenda

O módulo aparecerá na sua lista de módulos em “Modules & Services”.

Agora é hora de definir as configurações do módulo.

Como adicionar o banner de cookie e modificar as configurações

Agora que o módulo está pronto, precisamos alimentá-lo com as informações necessárias de sua conta da iubenda.

  • Se você não clicou no botão Configure em “Module installed!” na mensagem pop-up, navegue até a página Modules & Services e encontre o módulo iubenda: Plugin PrestaShop do iubenda
  • Clique em Configure para ir para as definições de configuração do módulo.
  • Adicione o código de sua conta da iubenda à extensão (o código de incorporação aparecerá desta forma em seu dashboard da iubenda): Incorporar a Cookie Solution (Se você ainda não gerou o banner de cookie e o código, pode fazê-lo aqui ou, para obter informações mais detalhadas, leia o guia de introdução à Cookie Solution da iubenda.)
  • Cole esse código no formulário do plugin e salve: Plugin PrestaShop do iubenda(Caso seja PHP nativo, recomendamos a opção principal e mais rápida para o mecanismo de parse. Se surgir algum problema, tente a alternativa com base em uma classe HTML DOM personalizada)

Utilização

Uma vez configurado, o plugin começará a mostrar o banner no qual sua política de cookies será exibida/vinculada aos usuários que visitam seu site pela primeira vez, sem a necessidade de quaisquer outras configurações. O plugin também irá reconhecer, detectar e bloquear automaticamente os cookies indicados na lista de bloqueio acima que estão presentes em seu site.

Importante

Nossa extensão PrestaShop bloqueia automaticamente os scripts gerados pelo servidor (portanto, retornados pelo PHP pelo PrestaShop). Os scripts inseridos na página via JavaScript após o processo de carregamento da página não são e não podem ser bloqueados automaticamente.

Esses scripts podem ser bloqueados por meio da inserção do código-fonte nas caixas de Custom Script no console do plugin ou, ainda, por meio do método de empacotamento manual, ilustrado no exemplo abaixo e (mais detalhadamente) nesta postagem de ajuda

Bloqueio de Custom Script de dentro do console

O campo Custom Script facilita o bloqueio de scripts inseridos na página diretamente do console do plugin. Isso reduz consideravelmente a necessidade de edições diretas no código do site.

Veja como fazer:

  • No menu esquerdo do painel do administrador, acesse a seção Improve e clique em Extensions > Plugins.
  • Em seguida, pesquise por “iubenda” e, quando o plugin aparecer, clique no botão Configure.
  • Deslize para baixo para encontrar os campos Custom Scripts e Custom Iframes na parte inferior da página.Campos Custom Scripts e Custom Iframes do PrestaShop
  • Insira suas fontes de script ou iframe conforme necessário e clique no botão Save na parte inferior direita da página.

Exemplos de utilização

Usar esses campos é muito simples. Basta inserir o script ou o atributo iframe src que deseja bloquear.

Script

Se você quiser bloquear um botão social (que insere scripts na página através do JavaScript), basta inserir a fonte do script, por exemplo, connect.socialwebsite.net/en_US/track.js, no campo de scripts.

iframe

Digamos que você queira bloquear scripts inseridos na página por meio do seguinte iframe

<iframe width="1280" height="720" src="https://www.videowebsite.com/embed/xxFhMChxx" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe> 

Você precisará inserir videowebsite.com/embed/ no campo iframe, uma vez que esta é a verdadeira fonte dos scripts. Cuidado para NÃO inserir o id do componente (videowebsite.com/embed/xxFhMChxx) para garantir que todos os scripts provenientes da verdadeira fonte sejam bloqueados.

Utilização manual (método de empacotamento)

Este método exige que você modifique diretamente o código do seu site. Você precisará acessar a seção correspondente do código do seu site e adicionar os scripts a serem bloqueados, conforme explicado abaixo.

Veja aqui um exemplo de como fazer o plugin funcionar manualmente em um botão Social (que insere scripts na página através do JavaScript).

<!--IUB-COOKIE-BLOCK-START-->
<script>
    (function(d, s, id) {
        var js, fjs = d.getElementsByTagName(s)[0];
        if (d.getElementById(id)) return;
        js = d.createElement(s);
        js.id = id;
        js.src = "//connect.socialwebsite.net/en_US/sdk.js#xfbml=1&version=v2.3&appId=808061959224601";
        fjs.parentNode.insertBefore(js, fjs);
    }(document, 'script', 'socialwebsite-jssdk'));
</script>
<!--IUB-COOKIE-BLOCK-END-->

Se houver elementos HTML / IMG / IFRAME, você precisará proceder da seguinte forma:

<!--IUB-COOKIE-BLOCK-START-->
      <iframe src="...
      <img src="...
<!--IUB-COOKIE-BLOCK-END-->

Se você ativou o recurso de consentimento por categoria, precisará atribuir a finalidade. Voltando ao exemplo do botão social, fazendo parte da finalidade de “Otimização da experiência” (id 3):

<!--IUB-COOKIE-BLOCK-START-PURPOSE-3-->
<script>
    ...
</script>
<!--IUB-COOKIE-BLOCK-END-PURPOSE-3-->

Para interromper o parse/substituição automática do iframe/scripts que contêm um src definido:

<!--IUB-COOKIE-BLOCK-SKIP-START-->
      <script type="text/javascript">...</script>
<!--IUB-COOKIE-BLOCK-SKIP-END-->

Informação adicional

Para chamadas de API e xmlrpc, sugerimos o parâmetro ?iub_no_parse=1.

Erro “Proibido” da PrestaShop
Atenção

Lembre-se sempre de fazer backup do seu site antes de qualquer reparo.

Em alguns casos raros, o sistema pode informar um erro “proibido” quando você insere o script da Cookie Solution, ou qualquer outro script, no módulo Cookie Solution e clica em “Save”.

Erro proibido do PrestaShop

Isso provavelmente está relacionado a uma instalação do ModSecurity no Apache ativado no backend do PrestaShop. Para resolver o problema, você precisará desativar o módulo mod_security. O que pode ser feito por meio do seguinte procedimento:

Clique em Shop Parameters -> Clique em Traffic&Seo -> Localize a opção “Disable Apache ModSecurity Module” e configure como “Yes”.

Se, por algum motivo, o procedimento não funcionar, pode ser necessário entrar em contato com o provedor de hospedagem web a respeito das restrições específicas do seu site.

1.1.17

Integrar com PageCache ultimate

1.1.16

Correção: evite substituir a atribuição da finalidade se ela já estiver definida

1.1.15

Correção: avaliação da finalidade para bloqueio de iframes
Correção: bloqueie os scripts personalizados durante o parse

1.1.14

Correção: siga o padrão do código para evitar conflito na substituição
Correção: adicione por finalidade em tags de script internos
Ajuste: Adicione GA ao suporte de bloqueio por finalidade

1.1.13

Correção: Mova a conexão do FB para otimização da experiência

1.1.12

Ajuste: adicione Google GPT ao suporte de bloqueio por finalidade
Correção: descontinuidade do método admin.js ready

1.1.11

Correção: limita a sanitização url para protocolos http
Correção: categoria por finalidade AddThis

1.1.10

Novo: suporte para bloqueio de script por finalidade
Novo: suporte ao botão “Reject”

1.0.9

Ajuste: Atualização da classe Simple HTML Dom PHP para 1.9
Ajuste: Código tratado com validador de código oficial

1.0.8

Novo: implementação de uma forma de pular o parse específico de script
Correção: manuseio aprimorado do HTML do script iubenda
Ajuste: atualização dos links de suporte

1.0.7

Ajuste: adapta o manuseio da classe PHP iubenda
Ajuste: Atualiza o logotipo do iubenda

1.0.6

Novo: opção para bloquear custom scripts e custom iframes personalizados
Ajuste: atualiza e amplia a lista de scripts bloqueados, incluindo Google Site Search, Google oAuth, widgets do LinkedIn, widgets do PayPal, Freshchat, UserVoice, AdRoll, Olark, Segment, Kissmetrics, Mixpanel, Pingdom, Bing e Elevio

1.0.5

Ajuste: atualiza e amplia a lista de scripts bloqueados, incluindo Pinterest, AddThis, Disqus, Optimizely, Neodata, Criteo, Outbrain, Headway e CodePen
Ajuste: melhorias de interface

1.0.4

Correção: implementação inválida do parser da iubenda

1.0.3

Ajuste: atualiza e unifica o mecanismo de parse da iubenda

1.0.2

Correção: Saída Eage vazia se o bloqueio de script estiver desativado

1.0.1

Ajuste: atualização de uma classe mais rápida do regex da iubenda

1.0

Lançamento inicial

Veja também