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

O que você vai aprender

Saiba como fazer a integração com o Magento 1. O Klaviyo se integra tanto ao Magento 1 CE quanto ao Magento 1 EE. Atualmente, oferecemos suporte às versões 1.5 e superiores do Magento.

Há duas etapas principais para a integração do Magento 1 com o Klaviyo:

1. Ativação da integração do Magento no Klaviyo.
2. Instalando a extensão Klaviyo no Magento.

Este guia abrange as duas etapas e as tarefas relacionadas para as lojas do Magento 1.

Configurar as credenciais da API do Magento

A integração do Magento 1.x com o Klaviyo requer a criação de uma nova função com acesso total aos recursos e a atribuição de um novo usuário a essa função. O nome de usuário e a senha desse usuário servirão como credenciais da API.

No painel de administração do Magento, clique na guia System (Sistema ) e selecione Web Services (Serviços da Web) > SOAP/XML-RPC-Roles (Funções SOAP/XML-RPC).

Selecione Add New Role (Adicionar nova função). Em seguida, clique na guia Role Resources (Recursos de função ) e defina Resource Access (Acesso a recursos ) como All (Todos).

Selecione a guia Role Info (Informações da função), nomeie a função como "Klaviyo," e clique em Save Role (Salvar função).

Clique na guia System e selecione Web Services > SOAP/XML-RPC-Users.

Selecione Add New User (Adicionar novo usuário).

Clique na guia User Role (Função do usuário ) e defina a função como Klaviyo.

Clique na guia User Info (Informações do usuário). Defina o nome de usuário como "klaviyo" e insira uma chave de API forte. O senhor pode digitar qualquer valor alfanumérico. Salve o User Name (nome de usuário ) e a API Key (chave de API ), pois você os usará ao ativar a integração do Magento 1 no Klaviyo. Preencha o restante das informações e clique em Save User (Salvar usuário).

Desempenho da API

Para melhorar o desempenho de sua integração, é altamente recomendável ativar o armazenamento em cache para as duas configurações do Magento Web Services Configuration.

No painel de administração do Magento, clique em System > Cache Management.

Habilite o armazenamento em cache nas duas configurações de Web Services Configuration.

Habilitar a integração do Magento 1 no Klaviyo

Use a chave da API do Magento que o senhor criou para ativar a integração do Magento 1 no Klaviyo.

Entre (na conta) em sua conta Klaviyo e clique no nome da sua conta no canto inferior esquerdo. Em seguida, selecione integrações > Add integrações e procure por Magento. Clique no cartão Magento e, em seguida, clique em Install (Instalar).

Digite as seguintes informações:

• URL do site
  O URL do site é o endereço de sua instância do Magento.
• Nome de usuário da API
  O nome de usuário que o senhor criou para o novo usuário com permissões de API.
• Senha / chave da API
  A chave da API que o senhor criou para o novo usuário.

Agora, clique em Connect to Magento (Conectar ao Magento). O senhor verá as seguintes opções avançadas e deverá ativá-las conforme necessário:

• Lojas
  Todas as lojas do Magento 1 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 (Suporte a várias lojas Magento ) para saber mais. 
• Configurações de preços especiais
  É altamente recomendável ativar o Special Price Settings se o senhor estiver planejando usar esse recurso. É mais difícil habilitar esse recurso posteriormente. O senhor pode ler mais sobre essa configuração na seçãoPreço especial abaixo.
• Configurações de cupom
  Leia este guia sobre como ativar cupons no Magento 1 e, em seguida, preencha esses campos.

Quando terminar, clique em Complete setup (Concluir configuração).

O Magento 1 agora está conectado ao Klaviyo. Em seguida, o senhor adicionará o Klaviyo Extension/Plugin à sua conta do Magento.

Instalar a extensão Klaviyo no Magento

A extensão Klaviyo adiciona o rastreamento Active on Site e Viewed Product à sua loja Magento. A instalação da extensão Klaviyo para Magento também é necessária para iniciar a sincronização dos eventos Checkout Started . É importante sincronizar seus eventos de Checkout Started para que eles possam acionar o fluxo de carrinho abandonado.

KlaviyoA extensão mais recente do Magento 1 é a v.1.9.0, atualização de outubro de 2024: Magento 1 v1.9.0 Extension Download.

Depois de fazer o download da extensão em seu computador, navegue até System > Magento Connect > Magento Connect Manager.

Em Direct package file upload, clique em Choose File e selecione a extensão que o senhor baixou acima. Clique em Upload. A extensão será carregada e instalada.

Depois de instalar a extensão, navegue até a página da extensão para definir as configurações.
Clique em System > Configuration e, em seguida, clique em Klaviyo na seção Customers (Clientes ). Se, depois de clicar em Klaviyo, o senhor receber uma mensagem 404, saia do Magento e faça login novamente.

Defina Enabled como Yes e preencha os outros campos. A Consumer Key (Chave do consumidor), o Consumer Secret (Segredo do consumidor), o Authorization Token (Token de autorização) e o Authorization Secret (Segredo de autorização) podem ser deixados em branco, a menos que o senhor esteja configurando cupons com o Magento.

Sincronizar um formulário de inscrição do Magento com uma lista do Klaviyo

Opcionalmente, é possível sincronizar um formulário de inscrição do Magento para que os usuários sejam adicionados a uma lista do Klaviyo.

Primeiro, crie uma lista no Klaviyo que você deseja sincronizar com o formulário de inscrição do Magento.

Se ainda não estiver na guia General Settings (conforme instruído na seção anterior), navegue até System > Configuration e clique em Klaviyo na seção Customers (Clientes ).

No menu suspenso General Subscription List (Lista de assinatura geral ), selecione a lista do Klaviyo com a qual deseja sincronizar.

Por padrão, a opção Use Klaviyo Opt-In Settings For This List está definida como Yes, ou seja, use as configurações do Klaviyo para essa lista. Recomendamos que o senhor mantenha essa configuração ativada. Quando essa configuração está ativada:

• Para uma lista double opt-in: o usuário receberá um e-mail de confirmação antes de ser adicionado à lista designada. Depois de confirmarem por e-mail, eles são adicionados à lista e é criada uma métrica Subscribe to List. Se nenhuma confirmação for recebida, eles não serão adicionados à lista.
• Para uma única lista opt-in: o cliente será adicionado a uma lista e uma métrica Subscribe to List será criada.

Se a opção No, do not send opt-in emails from Klaviyo estiver ativada, uma métrica Subscribed to List nunca será criada quando um perfil for adicionado a uma lista. Não recomendamos essa configuração, mas ela está disponível para preservar uma configuração herdada.

Configurar um cron job do Magento

A extensão Klaviyo usa cron jobs para se manter atualizada e executar tarefas de manutenção periódicas.

No Magento Admin Panel, vá para System > Configuration.

Role até a seção Advanced (Avançado ) e escolha System (Sistema).

Em seguida, selecione Cron (Scheduled Tasks). Configure um Cron para ser executado a cada 5 minutos e clique em Save Config.

Para obter mais informações sobre a configuração dos trabalhos cron do Magento, consulte a documentação do Magento para obter informações mais detalhadas sobre a configuração de um trabalho cron.

Configurar o cron em um sistema operacional baseado em UNIX

Se o senhor tiver acesso ao shell do servidor, poderá usar o comando crontab service. O cron do Magento precisa ser executado a cada cinco minutos, portanto, a configuração de tempo é:

*/5 * * * *

A linha completa no crontab será parecida com uma destas (sugerimos a primeira versão):

*/5 * * * * * /bin/sh MAGENTO_PATH/cron.sh
//5 * * * * * /bin/bash MAGENTO_PATH/cron.sh
//5 * * * * * /usr/bin/php MAGENTO_PATH/cron.php
*/5 * * * * * /usr/local/bin/php -f MAGENTO_PATH/cron.php

onde MAGENTO_PATH é o local de sua instalação do Magento no servidor.

Configure o cron usando o cPanel (ou seu provedor de hospedagem virtual)

Se não tiver acesso ao shell, o senhor pode consultar a documentação do seu provedor de hospedagem virtual. Abordaremos o uso do cPannel como exemplo a seguir.

Faça login no cPanel de sua conta de hospedagem. Localize a seção Advanced e clique no ícone "Cron Jobs".

Uma lista dos trabalhos cron atuais é exibida junto com um formulário para adicionar um novo trabalho. Digite as seguintes configurações no formulário "Add New Cron Job". Certifique-se de substituir MAGENTO_PATH pelo caminho para a instalação do Magento. Se não tiver certeza de qual é o caminho ou como encontrá-lo, o senhor pode usar um programa de FTP para procurar os arquivos no servidor e encontrar o diretório que contém o arquivo cron.sh.

Depois de adicionar o novo cron job, o senhor deverá ver os dados de checkout no Klaviyo em 15 minutos.

Monitoramento da sincronização de dados históricos

Na primeira integração com o Magento 1, o Klaviyo sincronizará os dados dos últimos 90 dias do Magento 1 para que você possa começar imediatamente a envolver seus clientes mais recentes. Após a sincronização dos 90 dias de dados mais recentes, o Klaviyo iniciará a sincronização completa dos dados históricos. Dependendo do número de pedidos, clientes e produtos de sua loja, a sincronização de todos os dados pode levar de alguns minutos a vários dias.

Depois que essa sincronização histórica for concluída, novos dados serão sincronizados com o Klaviyo a cada 30 minutos. Para verificar o progresso da sincronização inicial, clique na guia Analytics na barra lateral.

Localize a métrica Placed Order e altere o intervalo de datas do gráfico para ver quais datas foram totalmente sincronizadas. Quando a sincronização estiver concluída, a integração do Magento 1 naguia Integrations será marcada como concluída. Se quiser verificar por si mesmo que todos os dados do Magento 1 estão sincronizados, o senhor pode fazer uma verificação cruzada do total de pedidos durante alguns dias ou uma semana. Antes de iniciar a validação, verifique se o fuso horário de sua conta corresponde às configurações do Magento 1.

Dados sincronizados com a integração do Magento 1

A integração do Klaviyo com o Magento permite que o senhor extraia determinadas informações do cliente da sua plataforma Magento para enviar e-mails direcionados e orientados por dados no Klaviyo. Depois de configurar a integração, o senhor poderá personalizar e direcionar e-mails com base na compra do cliente e na atividade do site. Aqui estão alguns dos dados que sincronizamos do Magento:

• Informações sobre o cliente, incluindo nome, sobrenome e local.
• O Klaviyo sincroniza todos os clientes que assinam sua lista de boletins informativos do Magento. É importante garantir que qualquer cliente que faça parte de sua lista de boletins informativos do Magento tenha consentido em receber e-mails de marketing.
• Dados de pedidos cumpridos, reembolsados e cancelados.
• Quando as pessoas visitam seu site e quais itens e categorias elas visualizam.
  • Essas métricas serão exibidas em sua conta como Active on Site e Viewed Product.
  • O senhor não precisará adicionar o snippet de rastreamento do Klaviyo ao seu site com a integração do Magento, pois essas métricas já são tratadas pela nossa extensão.

Para saber mais, consulte Revisar e entender seus dados do Magento 1.

Criar uma chave de API com permissões limitadas

Esta documentação aborda a API SOAP do Magento na qual a integração do Klaviyo foi criada. Recomendamos conceder acesso a todos os pontos de extremidade no caminho /api/*. Embora isso provavelmente não corresponda diretamente às permissões que o senhor verá ao configurar o usuário e a função SOAP (já que as permissões foram alteradas em várias versões 1.x), aqui estão as chamadas de API que fazemos para o Magento 1.x:

• catalogCategoryTree
• catalogInventoryStockItemList
• catalogProductAttributeInfo
• catalogProductAttributeMediaList
• catalogProductInfo
• catalogProductList
• catalogProductTagList
• customerCustomerInfo
• customerCustomerList
• customerGroupList
• salesOrderInfo
• salesOrderList
• shoppingCartInfo
• storeList

Se o senhor precisar permitir determinadas portas (se tiver um firewall, por exemplo), a integração do Magento está atualmente em HTTP/80, mas se estiver disponível em 443, isso pode ser alterado.

Preço especial

Ao definir as configurações de integração, o senhor terá a opção de acessar "Special Price,", que se refere a um preço de venda especial para itens que podem, opcionalmente, entrar em vigor em um determinado intervalo de datas. Para cada produto, há quatro campos de metadados que serão sincronizados:

• price (float obrigatório): O preço padrão do item
• special_price (Opcional float): Esse é 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 (Data opcional): Especifica uma data de início para o special_price entrar em vigor
• special_to_date (Data opcional): Especifica uma data final para o special_price estar em vigor

Na página de configurações de integração do Magento 1, há uma caixa de seleção para Usar preço especial para preços de produtos quando aplicável. Quando essa configuração estiver ativada, o bloco do produto exibirá 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).

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

O Klaviyo suporta a conversão de todas as moedas estrangeiras do Magento em uma moeda principal no Klaviyo. Quando esse recurso está ativado, a conversão ocorre quando o Magento sincroniza os dados do pedido com o Klaviyo. Isso é especialmente útil se o senhor tiver várias lojas com transações em moedas diferentes.

O Klaviyo verificará se o order_currency_code é o mesmo que o global_currency_code definido. Caso contrário, o Klaviyo converterá o total do pedido da moeda do pedido para a moeda global especificada em suas configurações de integração. Isso garante que suas análises financeiras sejam precisas.

Atualize sua extensão

O senhor está usando uma versão de extensão do Magento inferior a 1.8.3? Recomendamos que o senhor atualize imediatamente para a versão 1.8.3. As versões mais antigas da extensão usam as APIs v1 e v2 do Klaviyo, que foram descontinuadas e não funcionam mais como esperado. 

Para atualizar sua extensão, remova a extensão antiga e siga as etapas contidas neste guia para reinstalá-la. O senhor pode fazer o download da versão 1.8.3 aqui: Download da extensão Magento 1 v1.8.3.