Iubenda logo
Crie Agora

Documentação

Tabela de conteúdos

Cookie Solution – guia de instalação de extensão do Magento

Esta extensão reduz significativamente a necessidade de intervenções diretas no código do site, integrando-se com a nossa Cookie Solution.

Ela fornece um banner de cookie totalmente personalizável, gera de forma dinâmica uma política de cookies que corresponde aos serviços utilizados em seu site, armazena provas das preferências dos usuários, e gerencia de forma integral o consentimento relacionado aos cookies – incluindo o bloqueio dos widgets mais comuns e de cookies de terceiros, antes mesmo que o consentimento seja recebido – com o objetivo de obedecer o GDPR, a Diretiva de Privacidade Eletrônica e a CCPA.

  • Nossas extensões estão disponíveis para o Magento 1.9.x e 2.x, mas observe que o Magento 1.x não possui mais assistência técnica desde 30 de junho de 2020. Quanto à versão 2.x, nossa extensão é compatível com o Magento Open Source (Magento Community Edition) e Magento Commerce (Magento Enterprise Edition e Magento Enterprise Cloud Edition).
  • Nossas extensões funcionam melhor com as versões do PHP 5.5 ou posteriores.

Funcionalidade

  • Permite que você bloqueie de forma automática ou manual os scripts que podem instalar cookies antes do consentimento, sem a necessidade de intervenção direta no código.
  • Permite que você detecte geograficamente e limite as solicitações de bloqueio prévio e consentimento de cookies dos usuários da UE – onde isso é um requisito legal – enquanto executa normalmente os scripts de cookies em regiões onde você ainda tem permissão legal para fazê-lo.
  • Reativa de maneira assíncrona os scripts de cookies, tão logo o consentimento é coletado.
  • Controla a exibição do banner e da política de cookies, permitindo que o banner seja integralmente personalizado, a fim de que combine com a aparência e as cores da marca de seu site, se necessário
  • Assistência à California Consumer Privacy Act (CCPA [Lei de Privacidade do Consumidor da Califórnia]).
  • Salva as preferências do usuário em relação ao uso de cookies e exibe uma página limpa (sem banner) para os usuários que já forneceram seu consentimento.
  • Integra-se com o Estrutura de Transparência e Consentimento do IAB (TCF 2.0).
  • Permite que seja fornecido a seus usuários um controle de preferência por categoria granular (por exemplo, funcionalidades básicas, otimização da experiência, direcionamento e publicidade).
  • Compatível com o Accelerated Mobile Pages (AMP) do Google.
  • Apresenta uma interface de fácil utilização para a inserção de scripts e iframes personalizados.
  • Detecta bots/spiders e fornece uma página limpa para que seu trabalho de SEO não seja comprometido.
  • 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

Instalação

Magento 2.x (Community Edition/Enterprise Edition/Cloud Edition)

  1. “Compre” nossa extensão gratuita no Marketplace do Magento. Feito isso, ela aparecerá na sua página de compras.
  2. Conecte-se ao log do console do servidor usando o SSH.
  3. Instale nossa extensão com o comando composer require iubenda/module-cookiesolution. Se você precisar de uma versão diferente da versão mais recente, adicione o número da versão ao comando, por exemplo iubenda/module-cookiesolution:2.2.0
  4. Quando solicitado, use a Chave pública do Marketplace do Magento para o login e a Chave privada para a senha (observe que você precisa comprar a extensão para continuar a instalação usando o composer).
  5. Assim que a extensão for instalada, verifique o status com o comando php bin/magento module:status
  6. A extensão deve estar desativada. Ative-a com php bin/magento module:enable Iubenda_CookieSolution e registre com php bin/magento setup:upgrade
  7. Se nossa loja estiver em modo de produção, compile a configuração com php bin/magento
    setup:di:compile
  8. Verifique novamente se nossa extensão está ativa com php bin/magento module:status. Em caso afirmativo, remova o cache com php bin/magento cache:clean

Instruções de desinstalação para versões pré-marketplace

  1. Abra o arquivo config.php localizado na pasta “/app/etc/”, procure por 'iubenda_cookiesolution' => 1, substitua 1 por 0 e salve.
  2. Limpe a pasta “/app/code/Iubenda/CookieSolution”.
  3. Se o cache estiver ativado, você precisará fazer uma limpeza: acesse System > Cache Management, selecione todos os tipos de cache e clique em Refresh.
  4. Abra o arquivo config.php localizado na pasta “/app/etc/”, remova a linha
    'iubenda_cookiesolution' => 0 e salve
  • Faça login na área do administrador do Magento e acesse System > Magento Connect > Magento Connect Manager
  • Digite novamente suas credenciais de administração do Magento
  • Marque a opção Create Backup e selecione o tipo de backup.

Após criar um backup, você poderá carregar o pacote disponível aqui.

Uma vez instalada a extensão, volte ao administrador do Magento e configure sua extensão da iubenda.

Configuração

Após a instalação ser concluída com sucesso, acesse Stores > Configuration > iubenda > iubenda Cookie Solution (é aqui que você pode configurar nossa extensão).

Copie e cole o código do JavaScript da Cookie Solution de sua conta iubenda (conforme descrito no guia de introdução), salve e limpe o cache da loja.

Atenção

Não esqueça de salvar o código válido do JavaScript para garantir o correto funcionamento da extensão

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

Nossas extensões do Magento bloqueiam automaticamente os scripts gerados pelo servidor (portanto, retornados pelo PHP pelo Magento). Os scripts inseridos na página pelo JavaScript após o processo de carregamento 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 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.

Magento 2.x (Community Edition/Enterprise Edition/Cloud Edition)

No painel do administrador, acesse Stores > Configuration > iubenda > iubenda Cookie Solution.

menu de config da iubenda no magento

Deslize para localizar os campos Custom scripts e Custom iframes na seção intitulada Custom.

campos Custom scripts da cookie solution da iubenda

Insira suas fontes de script ou iframe conforme necessário e clique no botão Save Config na parte superior da página.

No painel de administração, acesse System > Configuration. Em seguida, clique em iubenda Cookie Solution à esquerda do menu Configurações em Services. interface do Custom scripts da cookie solution da iubenda

Em seguida, basta deslizar até a seção Custom interface do Custom scripts da cookie solution da iubenda

Insira suas fontes de script ou iframe conforme necessário e clique no botão Save Config na parte superior 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-->

Instale a extensão Cookie Solution

Magento 2.x Community Edition/Enterprise Edition/Cloud Edition

ou

Magento 1.9.x

Veja também