Como ligar o Stripe ao Shopify Flow

A Stripe é uma plataforma de pagamentos. Envia um Webhook por cada pagamento, reembolso, litígio, alteração de subscrição e evento de faturação na sua conta. O Workflow Webhooks transforma essa chamada num gatilho do Shopify Flow, para que a sua loja possa reagir a ela: atribuir uma Tag a um cliente, adicionar uma nota ao pedido, enviar um e-mail interno, atualizar um metacampo - tudo o que o Shopify Flow permite fazer.

Este guia define todo o processo - o Stripe envia, o Workflow Webhooks recebe e verifica, o Shopify Flow processa - com a assinatura HMAC do Stripe verificada em cada pedido, pelo que apenas o Stripe pode iniciar o seu fluxo de trabalho.

O que pode construir

  • Assinale um cliente do Shopify que tenha efetuado o pagamento através de um checkout do Stripe ou de um link de pagamento, para que os seus segmentos se mantenham sincronizados.
  • Adicione uma nota ao pedido e alerte a sua equipa assim que for aberta uma contestação.
  • Envie um e-mail à equipa sempre que um pagamento de subscrição falhar, para que alguém possa entrar em contacto com o cliente antes que este se desligue.

Eventos típicos a enviar: payment_intent.succeeded, charge.refunded, charge.dispute.created, customer.subscription.deleted, invoice.payment_failed.

Antes de começar

  • Workflow Webhooks instalado na sua loja Shopify.
  • Shopify Flow instalada, que está disponível gratuitamente na App Store da Shopify.
  • Uma conta no Stripe com permissão para criar webhooks.

Passo 1 - Crie o webhook em Workflow Webhooks

  1. Aceda a Workflow Webhooks -> Webhooks -> Criar webhook e atribua-lhe um nome que consiga reconhecer no Shopify Flow, como, por exemplo, Stripe events.
  2. Na secção «Autenticação», selecione HMAC.
  3. Na secção «Provedor de assinatura», selecione «Stripe». A aplicação preenche automaticamente o cabeçalho, o algoritmo, o payload assinado e a janela de repetição por si - não há mais nada a configurar.
  4. Por enquanto, deixe o campo «segredo» em branco e clique em «Guardar». Copie o URL do webhook apresentado na página.

Consulte Autenticação para conhecer os outros modos de autenticação e Mapeamento da carga útil e variáveis de fluxo para escolher quais os campos que são transmitidos ao Shopify Flow.

A webhook com autenticação HMAC e o Stripe como fornecedor de assinatura, apresentando o campo «segredo de assinatura», o que este verifica e os passos para ligar o Stripe
Um remetente assinado, neste caso o Stripe: selecione o fornecedor, cole o seu segredo de assinatura e o editor mostra o que está marcado e como o ligar.

Passo 2 - Adicione o ponto de extremidade no Stripe

No Painel de Controlo do Stripe, abra «Desenvolvedores» → «Webhooks», adicione um ponto de extremidade com o URL que copiou e selecione os eventos que pretende enviar.

Como encontrar o seu segredo de assinatura do Stripe

Segredo de assinatura do webhook (whsec_...) no Painel de Controlo do Stripe -> Desenvolvedores -> Webhooks.

A própria documentação da Stripe sobre assinaturas de webhooks contém o texto exato e as imagens de ecrã relativas à sua conta.

Cole esse segredo no campo «Secret» do webhook em Workflow Webhooks e guarde. A partir desse momento, todas as entregas do Stripe serão verificadas antes de chegarem ao Shopify Flow.

O que isto verifica

O quê Valor
Cabeçalho da assinatura Stripe-Signature
Onde se encontra a assinatura No valor v1 desse cabeçalho, que contém pares key=value separados por vírgulas
O que foi assinado {timestamp}.{body}
Assinatura HMAC-SHA256, codificado em hexadecimal
Data e hora O valor t do cabeçalho da assinatura, expresso em segundos do Unix
Proteção contra reprodução Os pedidos cujo carimbo temporal assinado esteja a mais de 5 minutos do momento atual são rejeitados
O segredo Utilizado como texto simples. Cole-o exatamente tal como o remetente o apresenta

Na payload assinada, {body} corresponde ao corpo da solicitação em formato bruto, byte a byte, e {timestamp} corresponde ao carimbo temporal acima.

Um pedido que não cumpra qualquer um destes requisitos é rejeitado com o código de erro 401, é registado em Histórico e resolução de problemas e nunca dá início a um fluxo de trabalho.

Passo 3 - Criar o fluxo de trabalho Shopify Flow

  1. No «Shopify Flow», crie um fluxo de trabalho e selecione o gatilho «Workflow Webhooks».
  2. Clique em «Registar eventos» e, em seguida, envie um evento de teste a partir do Stripe (ou utilize a opção «Enviar teste» em Workflow Webhooks) para que o Shopify Flow aprenda a estrutura dos seus dados.
  3. Cada webhook de que dispõe aciona o mesmo gatilho do Shopify Flow; por isso, adicione uma primeira condição com base no ID do webhook para que este fluxo de trabalho se aplique apenas ao Stripe. O ID é apresentado na página do webhook.
  4. Adicione as suas ações - identifique um cliente, adicione uma nota, envie um e-mail interno, atualize um metacampo.
Shopify Flow
Em Shopify Flow, selecione «Selecionar um gatilho», aceda a Workflow Webhooks e escolha «Gatilho de Webhook».
Condição do Shopify Flow: o ID do webhook é igual ao ID de um webhook
O primeiro passo de cada fluxo de trabalho: uma condição relativa ao ID do webhook, para que o fluxo de trabalho só seja executado para este webhook.
O fluxo de trabalho final: Gatilho por webhook, uma condição relativa ao ID do webhook e, em seguida, o envio de um e-mail interno no ramo «Verdadeiro»
O fluxo de trabalho final: gatilho, condição com base no ID do webhook e, em seguida, a sua ação no ramo «True».

Passo 4 - Teste-o de ponta a ponta

Gatilho para um evento real no Stripe. Em Workflow Webhooks -> Histórico, deverá ver a invocação com o estado «Sucesso». Se a assinatura estiver incorreta, será apresentada uma entrada com o estado «Falha» e o motivo correspondente; em Verificação de webhooks assinados, encontra explicações sobre o verificador de assinaturas, que lhe mostra exatamente em que etapa ocorreu a falha.

Uma invocação foi aberta no History com os seus cabeçalhos de pedido, payload, estado, duração e identificadores
Um evento «Entregue» na História: o estado «Sucesso» significa que Shopify Flow o aceitou.
A assinatura não corresponde▾

Por este pedido: o segredo (a causa mais comum - um espaço a mais ou uma chave do ambiente errado), se o remetente está a utilizar o segredo de um ponto final diferente e se algo entre o Stripe e a aplicação reescreve o corpo da mensagem. As assinaturas abrangem os bytes brutos, pelo que um proxy que reformate o JSON as invalida. O verificador de assinaturas na página do webhook mostra o texto exato que foi assinado.

Recebo um erro 401 em todos os pedidos▾

Verifique se a autenticação do webhook está definida para HMAC com o fornecedor Stripe selecionado, se o segredo está preenchido e se o Stripe está a enviar dados para o URL exatamente como o aplicativo o apresenta, incluindo o código no final.

Não aparece nada no Histórico▾

O pedido nunca chegou. Verifique novamente o URL no Stripe e consulte o registo de entregas do próprio Stripe para ver a resposta que recebeu. Um erro 404 significa que o webhook está incorreto ou foi eliminado; um erro 429 significa que ultrapassou o limite de invocações do seu plano - consulte Planos e utilização.

O fluxo de trabalho é executado para os eventos errados▾

Cada webhook da sua loja aciona o mesmo gatilho do Shopify Flow. Adicione uma condição relativa ao ID do webhook como primeiro passo do fluxo de trabalho ou restrinja os eventos que envia a partir do Stripe.

Os pedidos falham com a mensagem «carimbo temporal fora da tolerância»▾

O Stripe assina um carimbo temporal e a aplicação rejeita qualquer evento com mais de 5 minutos. Normalmente, trata-se de um problema de relógio do lado do remetente ou de uma entrega que o Stripe voltou a tentar muito mais tarde com o carimbo temporal original. As novas tentativas decorrentes da mesma solicitação original não podem ser aceites; solicite ao Stripe que envie um evento novo.

Relacionado