Service Worker Guia de Instalação Manual em VTEX IO / Legacy

Este guia ensina como instalar manualmente o arquivo de Service Worker da Inngage no seu ambiente VTEX IO
Written by Inngage
Updated 1 week ago

A base deste procedimento é a documentação “Como instalar um Service Worker”, disponível em:

https://help.vtex.com/pt/tutorial/como-instalar-um-service-worker–2H057iW0mQGguKAciwAuMe

https://newhelp.vtex.com/pt/docs/tutorials/como-instalar-um-service-worker?utm_campaign=portal_transition&utm_medium=modal&utm_source=old_portal

Ao final do processo, o Service Worker estará corretamente hospedado no domínio da loja e ativo no navegador, permitindo o funcionamento dos recursos de Web Push da Inngage.

📋 Pré-requisitos

  • A loja não pode usar checkout customizado.

  • Acesso ao Admin VTEX com permissão para editar configurações do Checkout.

  • Arquivo sw.js do Service Worker disponível no painel Inngage.

  • Domínio da loja servindo conteúdo via HTTPS.

Configuração na Plataforma Inngage

  1. Entre no Painel Inngage com suas credenciais.

  2. Vá até Configurações → Plataformas → Web Push.

  3. Localize a seção Service Worker e siga os passos:

    1. Adicione o caminho do arquivo /files/
    2. Escolha um nome para o arquivo, sugerimos inngage-sw.js
    3. Adicione o escopo de registro do arquivo /files/
    4. Faça Download do arquivo
    5. Renomeie o arquivo de acordo com a configuração na opção 2

Acessar o painel de arquivos da VTEX

  1. Acesse o Admin VTEX.

  2. Vá para: 

    Store Settings → Storefront → Checkout

  3. Clique no ícone de engrenagem (⚙️) no canto superior direito da tela.

  4. No menu lateral, clique na aba Code e depois em Files.

Fazer upload do arquivo do Service Worker

Para criar o script, siga o passo a passo abaixo:

  1. No Admin VTEX, acesse Configurações da loja > Storefront > Ckeckout, ou digite Checkout na barra de busca no topo da página.
  2. Clique no ícone de engrenagem ⚙️  do site desejado.
  3. Na aba Código, clique no botão Novo.
  4. Em seguida, clique em Arquivo.
  5. Preencha o nome do arquivo exatamente como o configurado na Inngage: Ex.: inngage-sw.js.
  6. Clique no botão Criar.
  7. Programe a funcionalidade.
  8. Clique em Salvar.

Apesar do arquivo se encontrar em /arquivos/service-worker.js, ele recebe o header Service-Worker-Allowed com valor /, o que permite interceptar requests da raiz do site.

Link da Documentação Oficial da VTEX

https://newhelp.vtex.com/pt/docs/tutorials/como-instalar-um-service-worker?utm_campaign=portal_transition&utm_medium=modal&utm_source=old_portal

Testando o Service Worker

Após esse passo, o arquivo estará hospedado no mesmo domínio da loja.

A URL seguirá este formato:

https://SEUDOMINIO/files/inngage-sw.js

👉 Verifique acessando essa URL no navegador. Ela deve retornar o conteúdo do arquivo e status 200 OK.

✅ Conclusão

Pronto! Com a URL configurada na Inngage, o Service Worker será automaticamente registrado nos navegadores dos visitantes da loja.

A partir desse momento, os recursos de Web Push passam a funcionar corretamente, permitindo o envio e recebimento de notificações.

Did this answer your question?