Como ligar o Paddle a umShopify Flow
A Paddle é um lojista registado para produtos digitais e assinaturas. A Paddle notifica-o sobre transações, assinaturas, reembolsos e alterações relativas aos clientes. A «Workflow Webhooks» transforma essa notificação 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 Paddle envia, Workflow Webhooks recebe e verifica, Shopify Flow executa - com a assinatura HMAC do Paddle verificada em cada pedido, pelo que apenas o Paddle pode iniciar o seu fluxo de trabalho.
O que pode construir
- Identifique um cliente do Shopify que também tenha uma subscrição do «Paddle», para que este veja os preços ou conteúdos corretos.
- Envie um e-mail à sua equipa quando uma subscrição for cancelada e o cliente tiver pedidos recentes no site Shopify.
- Registe o plano atual no registo do cliente como um metacampo.
Eventos típicos a enviar: transaction.completed, subscription.canceled, adjustment.created (reembolso), customer.updated.
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 Paddle com permissão para criar webhooks.
Passo 1 - Crie o webhook em Workflow Webhooks
- Aceda a Workflow Webhooks -> Webhooks -> Criar webhook e atribua-lhe um nome que reconheça no Shopify Flow, como, por exemplo,
Paddle events. - Na secção «Autenticação», selecione HMAC.
- Na secção «Provedor de assinatura», selecione «Paddle». A aplicação preenche automaticamente o cabeçalho, o algoritmo, o payload assinado e a janela de repetição - não é necessário configurar mais nada.
- 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.
Passo 2 - Adicione o ponto final no Paddle
No Paddle, abra «Ferramentas de programador» -> «Notificações», adicione um destino com o URL que copiou e selecione os eventos. A chave secreta é apresentada no destino.
Como descobrir o seu segredo de assinatura do Paddle
A chave secreta do destino da notificação (Paddle → Ferramentas de programador → Notificações).
A documentação do próprio Paddle sobre assinaturas de webhooks, disponível em, contém o texto exato e as capturas 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 Paddle serão verificadas antes de chegarem ao Shopify Flow.
O que isto verifica
| O quê | Valor |
|---|---|
| Cabeçalho da assinatura | Paddle-Signature |
| Onde se encontra a assinatura | No valor h1 desse cabeçalho, que contém pares key=value separados por ponto e vírgula |
| O que foi assinado | {timestamp}:{body} |
| Assinatura | HMAC-SHA256, codificado em hexadecimal |
| Data e hora | O valor ts do cabeçalho da assinatura, expresso em segundos Unix |
| Proteção contra reprodução | Os pedidos cujo carimbo temporal assinado se situe 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 carga útil 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 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
- No «Shopify Flow», crie um fluxo de trabalho e selecione o gatilho «Workflow Webhooks».
- Clique em «Registar eventos» e, em seguida, envie um evento de teste a partir do Paddle (ou utilize a opção «Enviar teste» em Workflow Webhooks) para que o Shopify Flow aprenda a estrutura dos seus dados.
- 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 limite exclusivamente ao Paddle. O ID é apresentado na página do webhook.
- Adicione as suas ações - identifique um cliente, adicione uma nota, envie um e-mail interno, atualize um metacampo.
Passo 4 - Teste-o de ponta a ponta
Aqueça um evento real no Paddle. Em Workflow Webhooks -> Histórico, deverá ver a invocação com o estado «Sucesso». Se a assinatura estiver errada, será apresentada uma entrada com o estado «Falha», acompanhada do motivo; e em Verificação de webhooks assinados encontra explicações sobre o verificador de assinaturas, que lhe mostra exatamente em que etapa ocorreu a falha.
A assinatura não corresponde▾
Por este pedido: o segredo (a causa mais comum - um espaço a mais ou uma chave proveniente de um ambiente errado), se o remetente está a utilizar o segredo de um ponto final diferente e se algo entre o Paddle e a aplicação reescreve o corpo da mensagem. As assinaturas abrangem os bytes brutos, pelo que 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á definida como HMAC com o fornecedor Paddle selecionado, se o segredo está preenchido e se o Paddle 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 Paddle e consulte o registo de entrega do próprio Paddle 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 com base no ID do webhook como primeiro passo do fluxo de trabalho ou restrinja os eventos que envia a partir do Paddle.
Os pedidos falham com a mensagem «carimbo temporal fora da tolerância»▾
O Paddle atribui um carimbo de data e hora aos eventos e a aplicação rejeita tudo o que tenha mais de 5 minutos. Normalmente, trata-se de um problema de relógio do lado do remetente ou de uma transmissão que o Paddle voltou a tentar muito mais tarde com o carimbo de data e hora original. As novas tentativas da mesma solicitação original não podem ser aceites; solicite ao Paddle que envie um evento novo.
Relacionado
- Verificação de webhooks assinados - todos os prestadores que verificamos e como descrever aqueles que não verificamos.
- Mapeamento da carga útil e variáveis de fluxo - extrair os campos corretos do payload e transferi-los para o Shopify Flow.
- Proteção contra entregas duplicadas - o que acontece quando o Paddle tenta novamente uma entrega.
- Histórico e resolução de problemas - o registo de cada pedido, com reprodução.