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

Esta página o orienta sobre como integrar o Braze ao Shopify usando nossa integração padrão para usuários com uma loja on-line do 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 do Shopify, selecione Iniciar configuração para iniciar o processo de integração.



3. Na loja de aplicativos da Shopify, instale o aplicativo Braze.

4. Depois de instalar o app Braze, você será redirecionado ao Braze para confirmar o espaço de trabalho que deseja conectar ao 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 do Braze Web

Para lojas on-line do 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 o Braze deve inicializar e carregar os SDKs em uma das seguintes opções:

• Na visita ao local, como no início da sessão
  • Rastreamento de 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 inscrevem-se ou fazem login em suas contas

Etapa 3: Configure seus dados da Shopify

Configuração de dados padrão

Agora você selecionará os dados do 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 do Shopify.

Configuração histórica de aterro

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

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

À medida que seus registros de clientes do Shopify forem carregados no Braze, o ID do cliente do Shopify será usado como o ID externo do Braze.

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

Com os SDKs do Braze, você pode rastrear eventos personalizados ou atributos personalizados que vão além dos eventos padrão para essa integração. Os eventos personalizados capturam interações exclusivas em 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 de sua loja no arquivo theme.liquid. Talvez você precise da ajuda de 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, o Braze converte automaticamente os e-mails do Shopify em letras minúsculas antes de usá-los como ID externo. Se estiver usando e-mail ou envio de 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 nas IDs externas e evita a criação de perfis de usuário duplicados no Braze.

Etapa 4.1: Criar o metacampo braze.external_id

1. Em seu painel de administração do 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 docustomer/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 ponto de extremidade para recuperar sua ID externa

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

Especificações do endpoint

Método: OBTER

O 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

O 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 os sites shopify_customer_id e 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 fusão

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

• Implicações da fusão: Se o endpoint falhar (não retornar200 ou atingir o tempo limite), o Braze não poderá recuperar a ID externa. Consequentemente, a fusão entre o usuário do Shopify e o perfil do usuário do Braze não ocorrerá nesse momento.
• Lógica de repetição: O 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 sua ID externa

Repita a etapa 4 e insira o URL do endpoint depois de selecionar ID externa personalizada como o tipo de ID externa do Braze.

Considerações

• Se seu ID externo não for gerado quando o Braze enviar uma solicitação ao seu endpoint, a integração usará por padrão o ID do cliente do 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 externas existam em seu espaço de trabalho.
• Quando a ID externa estiver disponível no metacampo braze.external_id, a integração priorizará e atribuirá essa ID externa.
  • Se o ID do cliente do Shopify tiver sido definido anteriormente como o ID externo do Braze, ele será substituído pelo valor do metacampo braze.external_id.

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

Você tem a opção de coletar suas aceitações de marketing por e-mail ou SMS no 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 no Braze. Se você sincronizar as aceitações de e-mail marketing do Shopify, o 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 de sua loja Shopify com um catálogo 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 em 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 sinalizadores de recursos, você precisará colaborar com seus desenvolvedores para inserir o código SDK necessário diretamente em seu arquivo theme.liquid. Para obter instruções detalhadas, consulte Integração do SDK do Braze.

Notificações por push na Web

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

Etapa 7: Concluir configuração

1. Depois de fazer as configurações, selecione Finish Setup (Concluir configuração).
2. Ative a incorporação do app Braze nas configurações do tema do Shopify. Selecione Open Shopify para ser redirecionado à sua conta do 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 do Shopify.