Como ligar Shopify a Shopify Flow
Shopify assina os seus próprios webhooks e chamadas entre aplicações com o segredo da API da sua aplicação. Esta predefinição permite-lhe receber um Webhook de outra loja Shopify ou da sua própria aplicação e verificá-lo exatamente da forma descrita em Shopify. O «Workflow Webhooks» transforma essa chamada num gatilho do «Shopify Flow», para que a sua loja possa reagir à mesma: 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 pode fazer.
Este guia define todo o percurso - Shopify envia, Workflow Webhooks recebe e verifica, Shopify Flow executa - com a assinatura HMAC de Shopify verificada em cada pedido, pelo que apenas Shopify pode iniciar o seu fluxo de trabalho.
O que pode construir
- Replique um pedido de uma segunda loja Shopify para esta: identifique o cliente, adicione uma nota ou inicie um fluxo de trabalho de processamento do pedido.
- Reaja no Shopify Flow a um tópico que o Shopify Flow não disponibiliza, por si só, como gatilho, subscrevendo-o a partir da sua própria aplicação.
- Mantenha uma loja grossista e uma loja retalhista em sincronia sem ter de criar um serviço de middleware.
Eventos típicos a enviar: orders/create, products/update, customers/create, fulfillments/create.
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 Shopify 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 consiga reconhecer no Shopify Flow, como, por exemplo,
Shopify events. - Na secção «Autenticação», selecione HMAC.
- Na secção «Fornecedor de assinatura», selecione «Shopify». A aplicação preenche automaticamente o cabeçalho, o algoritmo, o payload assinado e a janela de repetição - não há mais nada a configurar.
- 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 saber como escolher quais os campos que são enviados para o Shopify Flow.
Passo 2 - Adicione o ponto final em Shopify
Crie uma subscrição do webhook na loja ou na aplicação de envio utilizando o URL que copiou e assine-a com o segredo da API dessa aplicação.
Como encontrar o seu segredo de assinatura Shopify
O segredo da API da sua aplicação / o segredo de assinatura do webhook.
A própria documentação da Shopify sobre assinaturas de webhooks 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 Shopify serão verificadas antes de chegarem ao Shopify Flow.
O que isto verifica
| O quê | Valor |
|---|---|
| Cabeçalho da assinatura | X-Shopify-Hmac-Sha256 |
| Onde se encontra 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 reprodução | Nenhuma - este remetente não assina o carimbo temporal, pelo que todas as assinaturas válidas permanecem válidas |
| 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.
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
- 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 de Shopify (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 aplique apenas a Shopify. 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
Aceda um evento real em Shopify. 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, é explicada a ferramenta de verificação 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 do ambiente errado), se o remetente está a utilizar o segredo de um ponto final diferente e se algo entre Shopify e a aplicação reescreve o corpo da mensagem. As assinaturas abrangem os bytes em bruto, 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 todas as solicitações▾
Verifique se a autenticação do webhook está definida como HMAC, com o fornecedor «Shopify» selecionado, se o segredo está preenchido e se Shopify está a enviar dados para a URL exatamente como a aplicação a apresenta, incluindo o código no final.
Não aparece nada no Histórico▾
O pedido nunca chegou. Verifique novamente o URL em Shopify e consulte o registo de entrega do próprio Shopify para ver a resposta que recebeu. Um 404 significa que o webhook está incorreto ou foi eliminado; um 429 significa que excedeu 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 de Shopify.
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 Shopify tenta novamente efetuar uma entrega.
- Histórico e resolução de problemas - o registo de cada pedido, com reprodução.