Como conectar o Paystack ao Shopify Flow

A Paystack é uma plataforma de pagamentos amplamente utilizada em toda a África. Ela o notifica sobre cobranças, transferências, assinaturas e reembolsos. O Workflow Webhooks transforma essa notificação em um gatilho do Shopify Flow, para que sua loja possa reagir a ela: marcar um cliente, adicionar uma nota ao pedido, enviar um e-mail interno, atualizar um metacampo - tudo o que o Shopify Flow pode fazer.

Este guia define todo o fluxo - a Paystack envia, Workflow Webhooks recebe e verifica, Shopify Flow executa - com a assinatura HMAC da Paystack verificada em cada solicitação, de modo que somente a Paystack possa iniciar seu fluxo de trabalho.

O que o senhor pode construir

  • Marque um cliente do Shopify que tenha efetuado o pagamento por meio do checkout do Paystack.
  • Adicione uma observação ao pedido quando o reembolso for concluído.
  • Envie um e-mail à equipe quando uma cobrança recorrente de uma assinatura não for bem-sucedida.

Eventos típicos a serem enviados: charge.success, transfer.success, subscription.disable, refund.processed.

Antes de começar

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

Etapa 1 - Crie o webhook em Workflow Webhooks

  1. Acesse Workflow Webhooks -> Webhooks -> Criar webhook e atribua a ele um nome que você reconheça no Shopify Flow, como, por exemplo, Paystack events.
  2. Na seção “Autenticação”, selecione HMAC.
  3. Em “Provedor de assinatura”, selecione Paystack. O aplicativo preenche automaticamente o cabeçalho, o algoritmo, o payload assinado e a janela de repetição para você - não há mais nada a ser configurado.
  4. Deixe o campo “segredo” em branco por enquanto e clique em “Salvar”. Copie a URL da Webhook exibida na página.

Consulte Autenticação para conhecer os outros modos de autenticação e Mapeamento de payload e variáveis de fluxo para escolher quais campos serão enviados ao Shopify Flow.

Etapa 2 - Adicione o endpoint no Paystack

No Painel do Paystack, abra Configurações -> Chaves de API e Webhooks e defina a URL do Webhook como a URL que o(a) senhor(a) copiou.

Como localizar seu segredo de assinatura do Paystack

Sua chave secreta do Paystack (sk_...). O Paystack realiza a assinatura com a chave da conta, e não com uma chave secreta específica para cada webhook.

A própria documentação da Paystack sobre assinaturas de webhooks contém o texto exato e as capturas de tela referentes à sua conta.

Cole esse segredo no campo “Secret” do webhook em Workflow Webhooks e salve. A partir desse momento, todas as entregas do Paystack serão verificadas antes de chegarem ao Shopify Flow.

O que isso verifica

O que Valor
Cabeçalho de assinatura x-paystack-signature
Onde fica a assinatura O valor completo do cabeçalho
O que foi assinado {body}
Assinatura HMAC-SHA512, codificado em hexadecimal
Data e hora Não é utilizado por este remetente
Proteção contra reprodução Nenhuma - esse remetente não assina o carimbo de data e hora; portanto, todas as assinaturas válidas permanecem válidas
O segredo Utilizado como texto simples. Cole-o exatamente como o remetente o apresenta

Na payload assinada, {body} corresponde ao corpo bruto da solicitação, byte por byte.

Uma solicitação que não atenda a qualquer um desses requisitos é rejeitada com o código de erro 401, é registrada em Histórico e solução de problemas e nunca inicia um fluxo de trabalho.

Etapa 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 “Gravar eventos” e, em seguida, envie um evento de teste a partir do Paystack (ou utilize a opção “Enviar teste” em Workflow Webhooks) para que o Shopify Flow aprenda o formato dos seus dados.
  3. Cada webhook de que o senhor dispõe aciona o mesmo gatilho do Shopify Flow; portanto, adicione uma primeira condição com base no ID do webhook para restringir esse fluxo de trabalho exclusivamente ao Paystack. O ID é exibido na página do webhook.
  4. Adicione suas ações - marque um cliente, adicione uma nota, envie um e-mail interno, atualize um metacampo.
Shopify Flow
Em Shopify Flow, selecione “Selecionar um gatilho”, acesse 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 todo fluxo de trabalho: uma condição baseada no ID do webhook, para que o fluxo de trabalho seja executado apenas para esse webhook.
O fluxo de trabalho finalizado: Gatilho de webhook, uma condição baseada no ID do webhook e, em seguida, o envio de um e-mail interno no ramo “True”
O fluxo de trabalho finalizado: gatilho, condição baseada no ID do Webhook e, em seguida, sua ação no ramo “True”.

Etapa 4 - Teste de ponta a ponta

Aque um evento real no Paystack. Em Workflow Webhooks -> Histórico, o(a) senhor(a) deverá ver a invocação com o status “Sucesso”. Caso a assinatura esteja incorreta, o(a) senhor(a) receberá, em vez disso, um registro de falha com o motivo; e Verificação de webhooks assinados explica o verificador de assinatura, que mostra exatamente em qual etapa ocorreu a falha.

Uma invocação foi aberta no History com seus cabeçalhos de solicitação, payload, status, duração e identificadores
Um evento de entrega na História: o status “Sucesso” significa que Shopify Flow o aceitou.
A assinatura não corresponde▾

Nesse pedido: o segredo (a causa mais comum - um espaço a mais ou uma chave do ambiente errado), se o remetente está utilizando o segredo de um endpoint diferente e se algo entre o Paystack e o aplicativo reescreve o corpo da mensagem. As assinaturas abrangem os bytes brutos; portanto, um proxy que reformata 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 todas as solicitações▾

Verifique se a autenticação do webhook está configurada como HMAC com o provedor Paystack selecionado, se o segredo está preenchido e se o Paystack está enviando a solicitação para a URL exatamente como o aplicativo a exibe, incluindo o código no final.

Não há nada no Histórico▾

A solicitação nunca foi recebida. Verifique novamente a URL no Paystack e consulte o próprio registro de entrega do Paystack para verificar a resposta recebida. Um erro do tipo 404 indica um webhook incorreto ou excluído; um erro do tipo 429 significa que você ultrapassou o limite de chamadas do seu plano - consulte Planos e uso.

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 com base no ID do webhook como primeira etapa do fluxo de trabalho ou restrinja os eventos que você envia pelo Paystack.

Relacionado