Como conectar Shopify a Shopify Flow
Shopify assina seus próprios webhooks e chamadas entre aplicativos com o segredo da API do seu aplicativo. Esta predefinição permite que você receba um Webhook de outra loja do Shopify ou do seu próprio aplicativo e o verifique exatamente da maneira descrita em Shopify. O Workflow Webhooks transforma essa chamada 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 - Shopify envia, Workflow Webhooks recebe e verifica, Shopify Flow executa - com a assinatura HMAC de Shopify verificada em cada solicitação, de modo que somente Shopify possa iniciar seu fluxo de trabalho.
O que o senhor pode construir
- Replique um pedido de uma segunda loja do Shopify para esta: marque o cliente, adicione uma observação ou inicie um fluxo de trabalho de processamento de pedidos.
- Reaja em Shopify Flow para um tópico que o Shopify Flow não oferece como gatilho, inscrevendo-se nele a partir de seu próprio aplicativo.
- Mantenha uma loja atacadista e uma loja de varejo sincronizadas sem precisar desenvolver um serviço de middleware.
Eventos típicos a serem enviados: orders/create, products/update, customers/create, fulfillments/create.
Antes de começar
- Workflow Webhooks instalado na sua loja do Shopify.
- Shopify Flow instalado, que está disponível gratuitamente na App Store da Shopify.
- Uma conta no Shopify com permissão para criar webhooks.
Etapa 1 - Crie o webhook em Workflow Webhooks
- Acesse Workflow Webhooks -> Webhooks -> Criar webhook e atribua a ele um nome que você reconheça no Shopify Flow, como
Shopify events. - Na seção “Autenticação”, selecione HMAC.
- Em “Provedor de assinatura”, selecione “Shopify”. 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.
- 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 em Shopify
Crie uma assinatura do webhook na loja ou no aplicativo remetente usando a URL que você copiou e assine-a com o segredo da API desse aplicativo.
Como localizar seu segredo de assinatura do Shopify
O segredo da API do seu aplicativo / o segredo de assinatura do webhook.
A própria documentação do Shopify sobre assinaturas de webhooks contém o texto exato e as capturas de tela referentes à sua conta.
Cole essa chave secreta no campo “Secret” do webhook em Workflow Webhooks e salve. A partir desse momento, todas as entregas do Shopify serão verificadas antes de chegarem ao Shopify Flow.
O que isso verifica
| O que | Valor |
|---|---|
| Cabeçalho de assinatura | X-Shopify-Hmac-Sha256 |
| Onde fica a assinatura | O valor completo do cabeçalho |
| O que foi assinado | {body} |
| Assinatura | HMAC-SHA256, codificado em base64 |
| Data e hora | Não é utilizado por este remetente |
| Proteção contra repetição | Nenhuma - este 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
- No “Shopify Flow”, crie um fluxo de trabalho e selecione o gatilho “Workflow Webhooks”.
- Clique em “Gravar eventos” e, em seguida, envie um evento de teste pelo site Shopify (ou utilize a opção “Enviar teste” em Workflow Webhooks) para que o Shopify Flow aprenda o formato dos seus dados.
- Cada webhook de que o senhor é proprietário aciona o mesmo gatilho do Shopify Flow; portanto, adicione uma primeira condição com base no ID do webhook para que esse fluxo de trabalho se aplique apenas a Shopify. O ID é exibido na página do webhook.
- Adicione suas ações - marque um cliente, adicione uma nota, envie um e-mail interno, atualize um metacampo.
Etapa 4 - Teste de ponta a ponta
Acionem um evento real no Shopify. Em Workflow Webhooks -> Histórico, vocês deverão ver a invocação com o status “Sucesso”. Caso a assinatura esteja incorreta, será exibida uma entrada com status de falha e o motivo correspondente; além disso, Verificação de webhooks assinados explica como funciona o verificador de assinaturas, que indica exatamente em qual etapa ocorreu a falha.
A assinatura não corresponde▾
Nesta ordem: 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 Shopify 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 Shopify selecionado, se o segredo está preenchido e se Shopify está enviando dados 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 em Shopify e consulte o próprio registro de entrega do Shopify para ver a resposta recebida. Um 404 indica um webhook incorreto ou excluído; um 429 significa que você ultrapassou o limite de invocações 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 a primeira etapa do fluxo de trabalho ou restrinja os eventos que você envia a partir de Shopify.
Relacionado
- Verificação de webhooks assinados - todos os prestadores de serviços que verificamos e como descrever aqueles que não verificamos.
- Mapeamento de payload e variáveis de fluxo - extrair os campos corretos da payload e inseri-los em Shopify Flow.
- Proteção contra entregas duplicadas - o que ocorre quando o Shopify tenta novamente uma entrega.
- Histórico e solução de problemas - o registro de todas as solicitações, com reprodução.