Configuração da integração padrão da Shopify

Esta página orienta você sobre como integrar a Braze à Shopify usando nossa integração padrão para usuários com uma loja on-line da Shopify. Se você usa um site headless da Shopify ou está procurando implementar soluções mais personalizadas, consulte a configuração de integração personalizada da Shopify.

Etapa 1: Conecte sua loja da Shopify

1. Na Braze, acesse Integrações de parceiros > Parceiros de tecnologia e depois procure “Shopify”.

2. Na página do parceiro da Shopify, selecione Iniciar configuração para iniciar o processo de integração.
   
   
   
   
3. Na loja de aplicativos da Shopify, instale o aplicativo da Braze.
   
   

4. Depois de instalar o app da Braze, você será redirecionado à Braze para confirmar o espaço de trabalho que deseja conectar à Shopify. Uma loja da Shopify pode se conectar a apenas um espaço de trabalho. Se precisar mudar, selecione o espaço de trabalho correto.
   
   

5. Selecione Iniciar configuração.
   
   

Etapa 2: Ativar os SDKs da Braze Web

Para lojas on-line da Shopify, você pode selecionar a configuração padrão para implementar automaticamente o Braze Web SDK e o JavaScript SDK.

Depois de selecionar a jornada de integração da configuração padrão, você precisará escolher quando a Braze deve inicializar e carregar os SDKs em uma das seguintes opções:

• Na visita ao site, como no início da sessão
  • Rastreia usuários identificados e anônimos
• Após o registro da conta, como o login da conta
  • Rastreia apenas usuários identificados
  • Começa o rastreamento de dados quando os visitantes do site se inscrevem ou fazem login em suas contas

Etapa 3: Configure seus dados da Shopify

Configuração de dados padrão

Agora você selecionará os dados da Shopify que deseja rastrear.

Os seguintes eventos serão ativados por padrão na integração padrão.

Para saber mais sobre os dados rastreados por meio da integração, consulte Recursos de dados da Shopify.

Configuração de backfill histórico

Por meio da configuração padrão, você tem a opção de realizar um carregamento inicial dos seus clientes e pedidos da Shopify dos últimos 90 dias antes da conexão de integração com a Shopify. Para isso, marque a caixa de seleção para incluir o carregamento inicial de dados como parte da sua integração.

Essa tabela contém os dados que serão carregados inicialmente por meio do backfill.

À medida que seus registros de clientes da Shopify são carregados na Braze, o ID do cliente da Shopify será usado como o ID externo da Braze.

(Avançado) Configuração de rastreamento de dados personalizados

Com os SDKs da Braze, você pode rastrear eventos personalizados ou atributos personalizados que vão além dos eventos padrão dessa integração. Os eventos personalizados capturam interações exclusivas na sua loja, como:

O rastreamento de dados personalizados fornece insights mais profundos sobre o comportamento do usuário e oferece suporte à personalização adicional. Para implementar eventos personalizados, é necessário editar o código do tema da sua loja no arquivo theme.liquid. Talvez você precise da ajuda dos seus desenvolvedores.

Por exemplo, o snippet JavaScript a seguir rastreia se o usuário atual está inscrito em uma newsletter e registra essa informação como um evento personalizado no perfil de usuário na Braze:

1
2
3
4
5
6
7
8
9
braze.logCustomEvent(
  “subscribed_to_newsletter”,
  {
    newsletterName: ‘News and Offers’,
    customerEmail: ‘customer_1@gmail.com’,
    sendOffers: true
  }
);

O SDK deve ser inicializado (ouvindo a atividade) no dispositivo de um usuário para registrar eventos ou atributos personalizados. Para saber mais sobre o registro de dados personalizados, consulte o objeto User e o objeto logCustomEvent.

Etapa 4: Configurar como gerenciar usuários

Selecione seu tipo de external_id no menu suspenso.

Por padrão, a Braze converte automaticamente os e-mails da Shopify em letras minúsculas antes de usá-los como ID externo. Se estiver usando e-mail ou e-mail com hash como ID externo, confirme se os endereços de e-mail também foram convertidos em letras minúsculas antes de atribuí-los como ID externo ou antes de fazer o hash a partir de outras fontes de dados. Isso ajuda a evitar discrepâncias nos IDs externos e a criação de perfis de usuário duplicados na Braze.

Etapa 4.1: Criar o metacampo braze.external_id

1. No painel de administração da Shopify, acesse Configurações > Metacampos e metaobjetos.
2. Selecione Clientes > Adicionar definição.
3. Em Name, digite braze.external_id.
4. Selecione o namespace e a chave gerados automaticamente (custom.braze_external_id) para editá-los e alterá-los para braze.external_id.
5. Em Type, selecione ID Type.

Depois que o metacampo for criado, preencha-o para seus clientes. Recomendamos as seguintes abordagens:

• Ouça os webhooks de criação de clientes: Configure um webhook para ouvir os eventos do customer/create. Isso permite que você escreva o metacampo quando um novo cliente é criado.
• Preencher os clientes existentes: Use a Admin API ou a Customer API para preencher novamente o metacampo de clientes criados anteriormente.

Etapa 4.2: Crie um endpoint para recuperar seu ID externo

Você deve criar um endpoint público que a Braze possa chamar para recuperar o ID externo. Isso permite que a Braze busque o ID em cenários em que a Shopify não pode fornecer o metacampo braze.external_id diretamente.

Especificações do endpoint

Método: GET

A Braze envia os seguintes parâmetros para seu endpoint:

Exemplo de endpoint

1
GET https://mystore.com/custom_id?shopify_customer_id=1234&[email protected]&shopify_storefront=dev-store.myshopify.com

Resposta esperada

A Braze espera um código de status 200 retornando o JSON do ID externo:

1
2
3
{
  "external_id": "my_external_id"
}

Validação

É fundamental validar se o shopify_customer_id e o email_address (se houver) correspondem aos valores do cliente na Shopify. Você pode usar a API do Shopify Admin ou a API do cliente para validar esses parâmetros e recuperar o metacampo braze.external_id correto.

Comportamento de falha e mesclagem

Qualquer código de status diferente de 200 é considerado uma falha.

• Implicações da mesclagem: Se o endpoint falhar (não retornar 200 ou atingir o tempo limite), a Braze não poderá recuperar o ID externo. Consequentemente, a mesclagem entre o usuário da Shopify e o perfil do usuário da Braze não ocorrerá nesse momento.
• Lógica de repetição: A Braze poderá tentar novas tentativas de rede padrão imediatas, mas se a falha persistir, a mesclagem será adiada até o próximo evento de qualificação (por exemplo, a próxima vez que o usuário atualizar seu perfil ou concluir um checkout).
• Capacidade de suporte: Para dar suporte à mesclagem de usuários em tempo hábil, certifique-se de que o seu endpoint esteja altamente disponível e lide com o campo opcional email_address de forma adequada.

Etapa 4.3: Insira seu ID externo

Repita a Etapa 4 e insira a URL do endpoint depois de selecionar ID externo personalizado como o tipo de ID externo da Braze.

Considerações

• Se seu ID externo não for gerado quando a Braze enviar uma solicitação ao seu endpoint, a integração usará por padrão o ID do cliente da Shopify quando a função changeUser for chamada. Essa etapa é crucial para mesclar o perfil do usuário anônimo com o perfil do usuário identificado. Como resultado, pode haver um período temporário durante o qual diferentes tipos de IDs externos existam no seu espaço de trabalho.
• Quando o ID externo estiver disponível no metacampo braze.external_id, a integração priorizará e atribuirá esse ID externo.
  • Se o ID do cliente da Shopify tiver sido definido anteriormente como o ID externo da Braze, ele será substituído pelo valor do metacampo braze.external_id.

Etapa 4.4: Colete suas aceitações de e-mail ou SMS da Shopify (opcional)

Você tem a opção de coletar suas aceitações de marketing por e-mail ou SMS da Shopify.

Se você usar os canais de e-mail ou SMS, poderá sincronizar seus estados de aceitação de marketing por e-mail e SMS na Braze. Se você sincronizar as aceitações de e-mail marketing da Shopify, a Braze criará automaticamente um grupo de inscrições para e-mail para todos os usuários associados a essa loja específica. Você precisa criar um nome exclusivo para esse grupo de inscrições.

Etapa 5: Sincronizar produtos (opcional)

Você pode sincronizar todos os produtos da sua loja da Shopify com um catálogo da Braze para uma personalização mais profunda do envio de mensagens. As atualizações automáticas ocorrem quase em tempo real para que seu catálogo reflita os detalhes atualizados dos produtos. Para saber mais, confira a sincronização de produtos da Shopify.

Etapa 6: Ativar canais (opcional)

É possível ativar as mensagens no app sem usar um desenvolvedor, configurando-as na sua instalação.

Suporte a canais SDK adicionais

Os SDKs da Braze ativam vários canais de envio de mensagens, incluindo Cartões de conteúdo.

Cartões de conteúdo e Feature Flags

Para adicionar Cartões de conteúdo ou Feature Flags, você precisará colaborar com seus desenvolvedores para inserir o código SDK necessário diretamente no seu arquivo theme.liquid. Para obter instruções detalhadas, consulte Integração do SDK da Braze.

Notificações por push na web

Atualmente, não há suporte para push para a web na integração com a Shopify. Para solicitar suporte, envie uma solicitação de produto por meio do portal do produto da Braze.

Etapa 7: Concluir configuração

1. Depois de fazer as configurações, selecione Concluir configuração.
2. Ative a incorporação do app da Braze nas configurações do tema da Shopify. Selecione Abrir Shopify para ser redirecionado à sua conta da Shopify e ativar a incorporação do app nas configurações de tema da sua loja.

3. Depois de ativar a incorporação do app, sua configuração estará concluída! Confirme que você pode visualizar suas configurações de integração, o status da sincronização inicial de dados e seus eventos ativos da Shopify.