Como integrar minha loja da Shopify à Kobana?

Matheus Gonçalves Atualizada Por Matheus Gonçalves

A Shopify é uma plataforma de e-commerce na qual você pode criar sua própria loja virtual totalmente hospedada com domínio personalizado. 

Para melhorar as suas vendas é possível integrar a sua loja da Shopify à Kobana e oferecer aos seus clientes a opção de pagamento por boleto, automatizando todo o processo.

Veja abaixo como fazer isso:

Para realizar o passo a passo abaixo é necessário que você tenha conta na Kobana e no Shopify.

Integrando sua loja do Shopify à sua conta da Kobana

  1. Criando método de pagamento

Logado no painel administrativo do Shopify, clique em Settings na parte de baixo do menu lateral.

Na próxima página, clique em Payments.

Desça até a área de Manual payment method e clique em Add manual payment method e selecione Create custom payment method. Agora você deve preencher com o nome do meio de pagamento, detalhes adicionais e instruções de pagamento. Ao finalizar o preenchimento clique em Activate.

Pronto! Você adicionou o boleto como uma forma de pagamento.

  1. Integrando sua loja à Kobana

Agora você vai criar a conexão entre a sua loja e a Kobana, de forma que a Kobana seja avisada pelo Shopify sempre que o seu cliente selecionar a opção de boleto.

No menu lateral, clique em Notifications.

No final da página, na área de webhooks, clique em Create webhook:

Agora você deverá criar dois webhooks: criação de pedido (order creation) e cancelamento de pedido (order cancellation). Para que dessa forma, a Kobana saiba quando é necessário gerar e cancelar um boleto.

Para criação do webhook de criação de pedido, você deve preencher seguindo a tabela abaixo:

  • Event: Order Creation
  • Format: JSON
  • URL: https://shopify.kobana.com.br/[token-API-Kobana]/[id-carteira]/[tag]
A URL deve ser preenchida de acordo com o token de API da sua conta da Kobana, que você pode ter acesso em Integrações > API > Token de API.

O id da carteira só será necessário ser preenchido se você tiver mais de uma carteira ou desejar utilizar as tags. Para ter acesso ao ID da sua carteira, acesse o menu Cobrança > Configurações > Carteiras.

A tag é utilizada para diferenciar boletos gerados através dessa integração e, principalmente, enviar notificações por e-mail e SMS diferentes de boletos que você gera por outros meios na Kobana. Caso isso seja interessante para a sua empresa, você pode colocar a tag, como, por exemplo, Shopify.
  • Webhook API Version: 2022-01

Clique no botão Save. E repita o procedimento para o cancelamento do pedido. A única diferença será colocar no evento order cancellation.

Você deverá terminar com 2 webhooks configurados.

  1. Habilitando o CPF no checkout

Sempre que você emite um boleto, nele deve constar o CPF ou CNPJ do pagador. Esse campo não é padrão no Shopify, por isso você deve habilitá-lo na sua loja. No menu lateral, clique em Checkout.

Encontre a área Customer Information e configure o Company Name como required (obrigatório). Em seguida clique em Save para salvar.

Retorne ao menu principal da sua loja clicando no "X" no topo direito da página.

Acesse Online Store no menu lateral.

Na área de Current Theme, clique em Customize.

No canto esquerdo superior da tela, clique nos três pontinhos (...) e em Edit Languages.

No canto esquerdo superior da tela que abrir, clique nos três pontinhos (...) e, então, em Checkout & system.

Procure na página os campos relativos a Company, que estão selecionados abaixo. À direita de cada um deles, digite CPF. Clique em Save.

Sua loja está pronta para cadastrar o CPF do seu cliente e enviar um comando para a geração do boleto na Kobana.

  1. Configurando a confirmação de pagamento

Precisamos agora configurar o sentido contrário. Quando um boleto for pago ou cancelado, o Shopify precisa ser informado para atualizar a ordem de compra.

O primeiro passo será criar uma aplicação no Shopfy. Acesse sua conta do Shopify, clique em Apps e depois em Develop Apps for your store.

Clique em Create an app.

Na janela que abrir insira Integração com a Kobana como o nome do app e clique em Create app. Agora clique em Configure Admin API Scopes.

Nesta área encontre Orders (View or manage orders, transactions, fulfillments, and abandoned checkouts) e marque o quadradinho para write_orders e read_orders. Para finalizar clique em Save.

Agora clique na aba API Credentials e em um local seguro, salve a API Key e a API secret Key.

Agora você deverá criar um webhook na Kobana. Acesse sua conta da Kobana e vá em Integrações > Webhooks > Contas e clique no botão para criar um novo webhook. Preencha o webhook da seguinte forma:

  • Endereço para o Payload (URL): https://shopify.kobana.com.br/update-order/[shop-name]/[api_key]/[password]
A URL deve ser preenchida com nome usado no endereço de acesso ao Shopify, substituindo o shop-name acima entre colchetes. Se o seu enderço for https://minhaloja.myshopify.com substitua [shop-name] por minhaloja.

A API key e o password serão substituídos pelos dados da API da sua conta da Shopify. Explicamos mais abaixo como ter acesso a isso.
  • Tipo da Requisição: application/JSON
  • Carteira: selecione a carteira correspondente de emissão de boletos
  • Eventos: boleto cancelado e boleto foi pago

Pronto! Agora quando um boleto for pago, a ordem de compra no Shopify será atualizada e toda vez que um boleto for cancelado dentro da Kobana, a ordem de compra será cancelada.

Configurando o envio automático de e-mail

Para o seu cliente receber o boleto por e-mail, você deve configurar na Kobana o envio automático. Para fazer isso, recomendamos que siga o passo a passo deste artigo: Como enviar notificações automáticas por e-mail?

Recomendamos, também, que considere seguir as práticas abaixo para ter uma boa experiência:

  • Utilizar o evento boleto gerado para que ocorra na momento da compra.
  • Inserir, também, o link do boleto no corpo do email. Isso pode ser feito utilizando as variáveis.
  • Caso você tenha utilizado as tags no webhook do Shopify, você pode aplicar elas nas notificações para só serem disparadas caso o boleto tenha sido gerado através da sua loja.
  • Você pode incluir o ID da compra, tipo de produto, número de ordem, entre outros campos no corpo do e-mail, se desejar. Para que o Shopify envie dados no campo Meta você deve preencher desta maneira: {"shopify":true,"order_id":1234,"order_number":0001}. Sendo esses números, apenas exemplos.
Se realizar um teste de compra na sua loja virtual para verificar o funcionamento da integração, você não poderá usar o mesmo e-mail cadastrado como dono da conta na Kobana, já que não é possível gerar um boleto para você mesmo na plataforma.

Como fizemos?

Como integrar a emissão de boletos registrados com outras ferramentas usando a Pluga

Como integrar a Kobana ao SharpSpring?

Contato