Como ligar o Sendcloud ao Shopify Flow
A Sendcloud trata do envio e do acompanhamento de encomendas. Envia um Webhook sempre que uma encomenda altera o seu estado. O «Workflow Webhooks» transforma essa chamada num gatilho do «Shopify Flow», para que a sua loja possa reagir a ela: marcar um cliente, adicionar uma nota à encomenda, enviar um e-mail interno, atualizar um metacampo - tudo o que o Shopify Flow permite fazer.
Este guia define todo o processo - a Sendcloud envia, o Workflow Webhooks recebe e verifica, e o Shopify Flow executa - com a assinatura HMAC da Sendcloud verificada em cada pedido, pelo que apenas a Sendcloud pode iniciar o seu fluxo de trabalho.
O que pode construir
- Adicione uma nota ao pedido no momento em que o pedido for entregue, sem necessidade de consultar a API da transportadora.
- Envie um e-mail ao representante atribuído ao cliente sempre que uma entrega falhar.
- Assinale os pedidos que se encontram retidos em trânsito por mais tempo do que o previsto, para que o suporte ao cliente possa tomar medidas.
Eventos típicos a enviar: é anunciado um envio, um envio está em trânsito, um envio é entregue, uma entrega falha.
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 Sendcloud 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,
Sendcloud events. - Na secção «Autenticação», selecione HMAC.
- Na secção «Fornecedor de assinatura», selecione «Sendcloud». 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 Sendcloud
No Sendcloud, abra as definições da integração e defina o URL do webhook como o URL que copiou. A Chave Secreta da integração é o que autentica o pedido.
Como encontrar o seu segredo de assinatura da Sendcloud
A chave secreta da integração (ou a chave de assinatura do Webhook).
A documentação da própria Sendcloud sobre assinaturas de webhooks, disponível em, contém o texto exato e as capturas de ecrã relativas à sua conta.
Cole essa chave secreta no campo «Secret» do webhook em Workflow Webhooks e guarde. A partir desse momento, todas as entregas da Sendcloud serão verificadas antes de chegarem ao Shopify Flow.
O que isto verifica
| O quê | Valor |
|---|---|
| Cabeçalho da assinatura | Sendcloud-Signature |
| Onde se encontra a assinatura | O valor completo do cabeçalho |
| O que foi assinado | {body} |
| Assinatura | HMAC-SHA256, codificado em hexadecimal |
| 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} constitui o 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 do Sendcloud (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 ao Sendcloud. 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 a um evento real no Sendcloud. 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-se o verificador de assinaturas que lhe indica 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 o Sendcloud e a aplicação reescreve o corpo da mensagem. As assinaturas abrangem os bytes em bruto, 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 todos os pedidos▾
Verifique se a autenticação do webhook está definida como HMAC com o fornecedor Sendcloud selecionado, se o segredo está preenchido e se o Sendcloud 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 Sendcloud e consulte o registo de entregas do próprio Sendcloud para ver a resposta que foi recebida. Um erro do tipo 404 significa que o webhook está incorreto ou foi eliminado; um erro do tipo 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 ativa ativa o mesmo gatilho do 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 Sendcloud.
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 da payload e transferi-los para o Shopify Flow.
- Proteção contra entregas duplicadas - o que acontece quando a Sendcloud volta a tentar efetuar uma entrega.
- Histórico e resolução de problemas - o registo de cada pedido, com reprodução.