Primeiros passos com o Magento 2.x (CE e EE)

O que você vai aprender

Saiba como integrar o Klaviyo à sua loja Magento 2 CE ou EE. O senhor precisará instalar a extensão do Klaviyo no Magento, configurar a extensão e definir o OAuth e, em seguida, ativar a integração no Klaviyo. Este guia aborda todas as etapas de integração necessárias, bem como a forma de confirmar que a sincronização de dados históricos foi bem-sucedida. 

Antes de começar

Para garantir que a Klaviyo possa fazer as chamadas de API necessárias para a integração, seu servidor Magento 2 deve ter um nome de host acessível publicamente. Os servidores Magento 2 hospedados localmente não poderão se integrar totalmente ao Klaviyo.

Encontre sua versão da extensão Klaviyo

Todos os intervalos de versões na tabela são inclusivos. Todas as extensões estão disponíveis para instalação por meio do Composer. 

O processo de instalação difere dependendo da versão do Magento 2 que o senhor estiver usando. 

Se estiver usando o Magento 2 versão 2.4.0 ou superior, siga as instruções detalhadas em Instalar com o Composer abaixo.

Para aqueles que usam versões do Magento 2 abaixo da 2.4.0: Lançamos correções para trazer compatibilidade entre versões mais antigas de nossas extensões e nossas novas APIs. Os links do Github são fornecidos na tabela acima, e eles também estão disponíveis para instalação via Packagist/Composer. Será necessário instalar por meio do método que você usa atualmente para instalar extensões (se for o Composer, siga a seção Instalar com o Composer abaixo). Se estiver usando o Magento 2 versão 2.2.0, o senhor também precisará ativar manualmente o OAuth após a instalação.

Instalar a extensão Klaviyo no Magento 2

Vídeo de instruções

Instalar com o Composer

1. Faça login no seu servidor Magento 2 e navegue até o diretório raiz do seu aplicativo Magento a partir da sua ferramenta de linha de comando. Este guia mostra exemplos de saídas para o Terminal, mas essas etapas podem ser modificadas para qualquer ferramenta de linha de comando de sua escolha.
2. Execute o seguinte comando para acessar a versão mais recente da extensão Klaviyo do Packagist. O Packagist é um repositório de bibliotecas de código PHP que permite que o senhor instale facilmente a versão mais recente da extensão.
   composer require klaviyo/magento2-extension
3. Se o senhor precisar instalar uma versão mais antiga da extensão do Magento 2 com o Composer, especifique a versão que deseja instalar. Por exemplo:
   composer require klaviyo/magento2-extension:3.0.4-patch
4. Execute o seguinte comando para ativar a extensão do Klaviyo que o senhor acabou de baixar:
   php bin/magento module:enable Klaviyo_Reclaim --clear-static-content
5. Conforme exibido no exemplo de saída, o senhor deve agora ativar quaisquer módulos adicionais. Execute o seguinte comando para habilitá-los:
   php bin/magento setup:upgrade
6. Examine a saída do módulo "Klaviyo_Reclaim" para confirmar que o módulo Klaviyo está ativado e em execução.
7. Para garantir que o CSS e o JS em sua loja do Magento 2 continuem funcionando corretamente, o senhor precisará executar um comando de implantação de conteúdo estático.
   php bin/magento setup:static-content:deploy -f
8. Agora o senhor pode retornar ao painel de administração do Magento a partir do navegador.

A instalação via Composer está concluída! Prossiga para a próxima seção para obter instruções de configuração.

Configurar a extensão Klaviyo

Vídeo de instruções

1. Em sua conta Klaviyo, navegue até a guia API keys (Chaves de API).
2. Em uma nova guia, navegue até o administrador da loja Magento.
3. Em Settings (Configurações), clique em Stores > Configuration (Configuração).
4. No menu suspenso do Klaviyo, clique em General (Geral).
5. Defina Enable Klaviyo Extension como Yes.
6. Copie sua chave de API pública de seis dígitos da Klaviyo na guia API keys e cole-a na caixa correspondente no Magento.
7. Na guia Klaviyo API keys (Chaves de API do Klaviyo), gere uma nova chave privada e cole-a na caixa correspondente no Magento. A autenticação com sua chave de API privada permitirá que o senhor sincronize as assinaturas da Newsletter do Magento com o Klaviyo.

Na próxima seção, você configurará o OAuth, que habilita outros aspectos da integração.

Configurar o OAuth

Em seguida, o senhor habilitará a autenticação OAuth para conectar com segurança sua conta Klaviyo à extensão do Magento 2. Temos um guia separado para aqueles com uma integração existente que precisam adicionar o OAuth. Se estiver usando o Magento 2 versão 2.2.0, visite nosso guia sobre como ativar manualmente o OAuth para sua integração. 

1. Navegue até a guia Setup OAuth (Configurar OAuth ) no Magento.
2. Dê à sua integração um nome memorável, pois o senhor precisará localizá-la por esse nome mais tarde.
3. Clique em Save Config para continuar.
   
4. Localize System (Sistema )no painel de navegação à esquerda e selecione Integrations (Integrações )na bandeja System (Sistema ).
5. Localize o nome da integração e clique em Activate (Ativar). A ativação da integração abrirá uma janela solicitando que o senhor aprove o acesso.
   
6. Clique em Allow para ser redirecionado para a Klaviyo, onde o senhor concluirá a configuração da integração.
   
7. Faça login na Klaviyo, se solicitado, ou confirme se o nome da sua conta está correto e clique em Integrate (Integrar ).Isso adicionará a integração do Magento 2 à conta do Klaviyo associada à chave de API que o senhor usou para a configuração. Se o senhor estiver conectado a várias contas do Klaviyo e a conta correta não estiver sendo exibida, saia de todas as outras sessões.
   

Se a janela se fechar automaticamente, a conexão foi bem-sucedida. O senhor também pode confirmar o sucesso abrindo sua conta Klaviyo em uma nova guia ou janela do navegador, clicando no nome da sua conta no canto inferior esquerdo, selecionando Integrações e procurando o Magento 2 na lista.

Se, em vez disso, receber o seguinte erro, verifique se as chaves de API usadas na primeira etapa correspondem à conta na qual o usuário está conectado no momento.

Ao estabelecer a conexão entre o Magento e a Klaviyo, se, em vez disso, o senhor receber uma lista de erros, poderá clicar em cada erro para saber mais sobre a causa.

Definir uma lista de boletins informativos

Em seguida, o senhor selecionará uma lista do Klaviyo para sincronizar os assinantes do boletim informativo. O senhor também tem a opção de usar as configurações de opt-in do Klaviyo ou as configurações de opt-in do Magento 2 para a lista escolhida.

1. No Magento, clique em Newsletter.
2. Selecione a lista do Klaviyo com a qual deseja sincronizar o formulário de inscrição do Magento no menu suspenso.
3. Clique em Save Config.

Habilitar o consentimento no checkout

Em seguida, o senhor pode optar por ativar o consentimento no checkout para e-mail e SMS.

Observe que, se ativar o consentimento no checkout, o senhor também precisará ativar os webhooks (abaixo) para que o consentimento no checkout funcione corretamente. 

1. Na página Configuration (Configuração ), em Klaviyo, navegue até Consent at Checkout (Consentimento no checkout).
   
2. O senhor verá uma seção para coletar consentimento por e-mail e consentimento por SMS. Os dois são tratados separadamente, de modo que o senhor pode coletar apenas e-mail, apenas SMS ou ambos. Se o senhor reunir assinantes de SMS e de e-mail, escolha uma lista diferente para SMS e para e-mail. Isso garante que o consentimento seja sempre atribuído adequadamente ao canal correto.
   • O consentimento não será sincronizado (tanto para e-mail quanto para SMS) até que o cliente termine de fazer o pedido e, se aplicável, confirme sua assinatura devido ao double opt-in.
   • Observe que, para os usuários já conectados à sua loja do Magento 2, a caixa de seleção de consentimento por e-mail não aparecerá no checkout por padrão.
3. Em Email, selecione Yes para Subscribe contacts to email marketing at checkout.
4. Selecione uma lista de e-mail para sincronizar os assinantes, como um boletim informativo.
5. Digite o texto da caixa de seleção de opt-in de e-mail que deseja usar.
   
6. Em SMS, selecione Yes para Subscribe contacts to SMS marketing at checkout.
7. Escolha a lista com a qual deseja sincronizar seus contatos SMS. Para obter mais detalhes sobre essas configurações, consulte nosso guia de coleta de consentimento de SMS no checkout.
   
8. A ordem de classificação permite que o senhor altere o posicionamento das caixas de consentimento de e-mail e SMS. Por padrão, essas caixas aparecem abaixo da primeira entrada de e-mail e do campo de número de telefone para envio, respectivamente. Portanto, se o senhor não tiver reorganizado a página de checkout, não precisará alterar a ordem de classificação. Se o senhor tiver alterado o layout, ajuste a ordem de classificação de acordo.
9. Quando terminar, clique em Save Config no canto superior direito.

Habilitar webhooks

1. No painel de controle do administrador, navegue até Stores > Configuration.
2. Clique em Klaviyo e selecione a guiaWebhooks. 
3. Crie um segredo de webhook e insira-o no campo Webhook Secretcorrespondente. O segredo do webhook é uma chave que o Klaviyo usará para validação. Esse segredo pode ser qualquer coisa que o senhor escolher, mas recomendamos criar uma sequência segura de letras e números. O Magento ocultará o segredo do webhook com asteriscos para fins de segurança, portanto, tenha cuidado para inseri-lo corretamente.
   
   Se estiver usando uma integração com várias lojas, o segredo do webhook nesse campo deverá ser inserido na configuração padrão e o mesmo segredo será usado como validação para cada configuração de loja. O segredo do webhook só deve ser adicionado à configuração padrão e não deve ser adicionado por loja.
4. Ao lado dos webhooks que o senhor deseja ativar, selecione Yes no menu suspenso. Para saber mais sobre os webhooks suportados pelo Klaviyo, consulte nosso guia de webhooks para Magento 2.
5. Clique em Save Config.

Habilitar a integração do Magento 2 no Klaviyo

Vídeo de instruções

1. Abra o Klaviyo, clique no nome da sua conta no canto inferior esquerdo e selecione Integrations (Integrações). Localize o Magento 2 na lista e selecione-o.
2. Na próxima página, o senhor terá a opção de adicionar novos clientes do Magento 2 a uma lista do Klaviyo. Clique na caixa de seleção Adicionar novos clientes do Magento 2 a uma lista do Klaviyo e selecione uma lista no menu suspenso. Observe que, ao marcar essa configuração, o senhor só adicionará clientes à lista selecionada, mas não os inscreverá em mensagens de marketing.
   
   Essa configuração sincronizará apenas os novos clientes; os clientes existentes precisam ser migrados manualmente da sua lista do Magento para a Klaviyo.
3. Em Advanced (Avançado), ative as seguintes configurações, conforme necessário :
   • Lojas
     Todas as lojas do Magento 2 são sincronizadas com o Klaviyo por padrão. Essa configuração permite que o senhor seja seletivo em relação às lojas com as quais se integra. Acesse Supporting multiple Magento stores para saber mais. 
   • Configurações de preço especial
     Essa configuração refere-se a um preço de venda especial para itens que podem, opcionalmente, entrar em vigor em um determinado intervalo de datas. É altamente recomendável ativar esse recurso se o senhor estiver planejando usá-lo, pois é mais difícil ativá-lo posteriormente. Quando o senhor ativa a opção Use special price for product prices when applicable (Usar preço especial para preços de produtos quando aplicável), o bloco de produtos exibe o preço especial quando aplicável. Ao usar um feed de produto dinâmico, o preço especial será preenchido no momento do envio. Ao selecionar manualmente itens do catálogo, o preço especial será preenchido assim que o senhor selecionar o(s) produto(s). Para cada produto, há 4 campos de metadados que serão sincronizados:
     
     • price
       (Obrigatório, float) O preço padrão do item.
     • special_price
       (Opcional, float) Este é um preço de venda especial para o item. Quando esse preço estiver em vigor, o senhor verá esse special_price ao lado de uma tarja do preço.
     • special_from_date
       (Opcional, data) Especifica uma data de início para o special_price entrar em vigor.
     • special_to_date
       (Opcional, data) Especifica uma data final para a vigência do special_price.
   • URL raiz da mídia personalizada
     Essa configuração permite que o senhor altere o caminho padrão para as imagens do seu site. Ative essa configuração se o senhor hospedar as imagens dos produtos em um URL diferente do seu site. 
4. Clique em Salvar.

O senhor conseguiu ativar a integração com o Magento 2! Seus dados começarão a ser sincronizados com o Klaviyo em minutos. 

Após a conclusão da sincronização inicial dos dados históricos, a integração do Magento 2 é sincronizada a cada 30 minutos.

Dados sincronizados com a integração do Magento 2

A integração do Klaviyo com o Magento 2 extrai as principais informações dos clientes de sua plataforma Magento.

Aqui estão alguns dos dados que sincronizamos do Magento:

• Informações sobre o cliente, incluindo nome, sobrenome e local.
• Dados de vendas e pedidos, incluindo quais itens foram comprados, imagens de itens, categorias de itens e quaisquer descontos aplicados.
• Dados de pedidos atendidos, reembolsados e cancelados.
• Quando as pessoas visitam seu site e quais itens elas visualizam, o rastreamento da Web é feito pela extensão.

Para saber mais, acesse nossa referência de dados do Magento 2. 

Converta os valores dos pedidos do Magento em uma única moeda

A Klaviyo suporta a conversão de todas as moedas estrangeiras no Magento para uma moeda principal na Klaviyo - entre em contato com o suporte para ativar esse recurso. Isso é especialmente útil se o senhor tiver várias lojas com transações em moedas diferentes.

Quando esse recurso está ativado:

• A conversão ocorre quando o Magento sincroniza os dados do pedido com o Klaviyo. 
• O Klaviyo verificará se o order_currency_code é o mesmo que o global_currency_codedefinido. Se não for, o Klaviyo converterá o total do pedido da moeda do pedido para a moeda global especificada para garantir que suas análises financeiras sejam precisas. Observe que os itens de linha do pedido permanecerão no código da moeda do pedido e não serão convertidos. 

Atualize sua extensão

Consulte a tabela abaixo: o senhor está usando uma versão de extensão abaixo da especificada para sua versão do Magento 2? Se for o caso, recomendamos que o senhor atualize sua extensão imediatamente. Algumas versões mais antigas da extensão usam as APIs v1 e v2 do Klaviyo, que foram desativadas e não funcionam mais como esperado. Fornecemos versões corrigidas específicas para ajudar os clientes em versões mais antigas do Magento 2, que estão relacionadas na tabela.

Primeiro, determine para qual versão da extensão o senhor precisa fazer upgrade usando a tabela abaixo. 

Todos os intervalos de versões na tabela são inclusivos. Todas as extensões estão disponíveis para instalação por meio do Composer. 

Agora que o senhor já determinou para qual versão deve fazer o upgrade, é hora de fazer o upgrade. O processo de atualização difere dependendo da versão do Magento 2 que o senhor estiver usando. 

Se o senhor estiver usando o Magento 2 versão 2.4.0 ou superior, siga as instruções detalhadas em Instalar com o Composer acima e execute o comando para instalar a versão mais recente. Isso substituirá sua versão atual e a atualização estará concluída - não há necessidade de reconfigurar a extensão ou reativar a integração no Klaviyo.

Para aqueles que usam versões do Magento 2 abaixo da 2.4.0: Lançamos correções para trazer compatibilidade entre versões mais antigas de nossas extensões e nossas novas APIs. Os links do Github podem ser encontrados na tabela acima, e eles também estão disponíveis para instalação via Packagist/Composer. Será necessário instalar por meio do método que você usa atualmente para instalar extensões (se for o Composer, siga a seção Instalar com o Composer acima).

Recursos adicionais

• Referência de dados do Magento 2
• Como coletar o consentimento por SMS no checkout no Magento 2
• Comunidade Klaviyo: Magento 2 "Ask Me Anything" Vídeo de perguntas e respostas