Sumário
Configurando sua integração OmniChat <> Nuvemshop
A integração entre a OmniChat e a Nuvemshop permite consultar os produtos, o estoque e os preços da sua loja durante os atendimentos, montar carrinhos e enviar ao consumidor o link para finalizar a compra no checkout da Nuvemshop, onde ele escolhe o frete e a forma de pagamento.
Também é possível acompanhar as atualizações dos pedidos (pagamento aprovado, pedido embalado, enviado ou cancelado) e recuperar carrinhos abandonados.
A Nuvemshop libera o acesso à sua loja por meio de um aplicativo. Por isso a configuração tem duas partes: primeiro você cria um aplicativo para a OmniChat no Portal de Parceiros da Nuvemshop e obtém as credenciais da sua loja; depois cadastra essas credenciais na OmniChat.
Antes de começar
Para realizar a configuração, você precisa:
Ter acesso administrativo à loja Nuvemshop;
Ter uma conta no Portal de Parceiros da Nuvemshop (é gratuita e pode ser criada com o mesmo e-mail da loja);
Ter acesso às configurações de integrações da OmniChat;
Saber o endereço da sua loja na internet (por exemplo, `https://minhaloja.lojavirtualnuvem.com.br` ou o seu domínio próprio);
Conseguir executar um comando no computador (Prompt de Comando no Windows ou Terminal no Mac) ou usar o Postman. Esse passo é necessário uma única vez, para gerar o token de acesso.
Criando o aplicativo e obtendo as credenciais na Nuvemshop
Passo 1: Acesse o Portal de Parceiros, https://partners.nuvemshop.com.br e faça login. Se ainda não tem conta, crie o seu cadastro no programa de parceiros antes de continuar.
Passo 2: Crie o aplicativo. No painel de parceiros, clique em **Criar aplicativo**.
Nome do aplicativo:
OmniChatE-mail de contato: um e-mail seu. A Nuvemshop usa esse e-mail para identificar o aplicativo nas requisições.
Como você quer distribuir seu aplicativo? escolha **Para os seus clientes**. Com essa opção o aplicativo não passa pelo processo de homologação da Nuvemshop e fica disponível apenas para a sua loja.
Passo 3: Clique em Criar aplicativo, ao criar o aplicativo você será redirecionado para a página dele.
Passo 4: Na página do aplicativo defina as permissões, para isso abra a aba Configuração e, em Dados básicos, clique em Editar dados. Role até a seção Permissões. Cada grupo abre ao clicar e mostra as opções de leitura e escrita. Marque as permissões abaixo, que são o mínimo que a OmniChat precisa; sem alguma delas a integração não será validada.
⚠️Atenção: Faça isso antes de instalar o aplicativo na loja. Se você alterar as permissões depois, a Nuvemshop exige desinstalar e instalar o aplicativo de novo, o que gera um token de acesso novo.
Grupo | Permissão |
Products | Read products |
Orders | Read orders e Write orders |
Manual orders | Read manual orders e Write manual orders |
Logistics | View Logistics |
Customers | Read customers |
Coupons | Read coupons |
Passo 5: Clique em Salvar no fim da página.
Passo 6: Ainda na pagina do aplicativo, clique em instalar.
Passo 7: Anote as chaves do aplicativo. Na aba Visão geral da página do aplicativo, localize o bloco Chaves de acesso e anote:
App ID (também chamado de
client_id);Client Secret.
⚠️Guarde o Client Secret com cuidado, pois ele é a senha do seu aplicativo.
Passo 8: Acesse a pagina de autorização do aplicativo instalado para obter o token de acesso. Para ter acesso ao id_aplicativo, na página de aplicativo na URL irá aparecer na URL. Quando ao campo sua_loja, é o nome da sua loja que você pode encontrar na aba Lojas.
Você pode acessar essa pagina com a seguinte url:
https://<sua_loja>.lojavirtualnuvem.com.br/admin/apps/<id_aplicativo>/authorize
Passo 9: Na tela de autorização, confira as permissões e clique em Aceitar e começar a usar.
Passo 10: Após aceitar a Nuvemshop redireciona você para uma página do Portal de Parceiros chamada Código para obter acesso a API (ela pode pedir o login do portal). Na primeira instalação, essa página mostra um comando `curl` já preenchido com o **código de autorização**. O código também aparece na barra de endereço do navegador, no parâmetro `code=` da URL dessa página; se a página não mostrar o comando, copie o código de lá.
⚠️ Atenção o código de autorização vale por **5 minutos** e só pode ser usado uma vez. Siga direto para o Passo 11!
Passo 11: Gere o token de acesso, copie o comando mostrado pela Nuvemshop e execute no Prompt de Comando (Windows) ou no Terminal (Mac). Ele tem este formato:
curl -d "{\"client_id\": \"<APP_ID>\", \"client_secret\": \"<CLIENT_SECRET>\", \"grant_type\": \"authorization_code\", \"code\": \"<CODIGO>\" }" -H "Content-Type: application/json" -X POST "https://www.nuvemshop.com.br/apps/authorize/token"
A resposta traz os dois dados que você vai cadastrar na OmniChat:
{
"access_token": "61181d08b7e328d256736hdcb671c3ce50b8af5",
"token_type": "bearer",
"scope": "read_products,read_orders,write_orders,...",
"user_id": "789"
}⚠️ Atenção o token de acesso não expira, mas deixa de valer se o aplicativo for desinstalado ou reinstalado na loja, ou se as permissões forem alteradas. Nesses casos, gere um token novo repetindo os Passos 5 e 6 e atualize a integração na OmniChat (veja Dúvidas frequentes). Não compartilhe o token e não o utilize em outra integração.
Criando a integração na OmniChat
Passo 1: Na plataforma OmniChat, acesse Configurações > Integrações.
Passo 2: Na tela de integrações, selecione E-Commerce / ERP e clique em Adicionar integração.
Passo 3: Na lista Nova integração, escolha Nuvemshop.
Passo 3: Preencha o formulário
Nome
O nome de exibição da integração. Este nome será utilizado internamente para identificar a integração na plataforma.
Times
Ao associar um ou mais times, a integração ficará disponível exclusivamente para os membros desse(s) time(s). Sem times associados, ela fica disponível para toda a loja.
ID da loja
Cole o valor de
user_idanotado anteriormente. É um número, como1234567.
Token de acesso
Cole o valor de
access_tokenanotado anteriormente. Se você gerar um token novo, informe-o aqui.
URL da loja
Informe o endereço principal da sua loja Nuvemshop, começando com
https://. Exemplo:https://minhaloja.lojavirtualnuvem.com.brSe a loja usa domínio próprio, informe o domínio próprio. Esse endereço é usado para montar os links de produtos e de carrinho enviados aos seus clientes.
Funcionalidades disponíveis
Carrinho abandonado: marque esta opção para que a OmniChat importe os carrinhos abandonados da loja e permita criar campanhas de recuperação. A importação acontece periodicamente e considera apenas os carrinhos abandonados a partir da ativação da integração.
Busca de produtos do Whizz Agent: Escolha como o Whizz, a Inteligência Artificial da OmniChat, vai buscar produtos nos atendimentos: Padrão (busca da própria integração), SERP (resultados orgânicos do Google) ou Híbrida (as duas). Se não tiver certeza, mantenha Padrão.
Configurando o webhook Intellipost (Opcional)
A Intelipost tem um aplicativo oficial na Loja de Aplicativos da Nuvemshop. Com a Intelipost configurada dentro da Nuvemshop, o seu cliente vê as opções de frete da Intelipost no checkout da loja. Com a chave da Intelipost na integração da OmniChat, a OmniChat passa a acompanhar a entrega de cada pedido (separado, enviado, saiu para entrega, falha na entrega e entregue) e avisa o cliente a cada mudança.
⚠️Atenção o aplicativo da Intelipost está disponível apenas no plano Nuvemshop Next.
Passo 1: Configurar o webhook no Intelipost. Nesse artigo explicamos para você.
Passo 2: No admin da Nuvemshop, abra Aplicativos e clique em Loja de aplicativos.
Passo 3: Procure por Intelipost e clique em Instalar. Aceite as permissões (Seguinte, Seguinte e Aceitar e começar a usar).
Passo 4: No cadastro do aplicativo, preencha a chave da API da Intelipost e clique em Finalizar cadastro.
Passo 5: As regras de frete e os centros de distribuição são configurados no painel da Intelipost.
⚠️ Para que o webhook funcione corretamente é necessário que seja efetuado o cadastro da API key do Intellipost na integração da OmniChat
Salvar configurações
Após preencher todos os campos, clique em Adicionar integração.
Nesse momento a OmniChat valida as credenciais na sua loja: confere o acesso à loja, aos produtos, aos pedidos, aos cupons e aos clientes. Se algum acesso falhar, a tela mostra qual deles e o que fazer:
Credenciais inválidas: confira o ID da loja e o token de acesso. Se o aplicativo foi reinstalado, o token mudou.
Permissão faltando: volte a etapa de criação do aplicativo, marque a(s) permissão(ões) que falta e reinstale o aplicativo. Será necessário gerar um token novo e informa-lo na integração.
Conclusão
Com estes passos concluídos, a integração fica com o status Ativa assim que a validação das credenciais termina, e já pode ser usada nos atendimentos. A partir daí você pode consultar os produtos da sua loja diretamente nas conversas, compartilhar detalhes com os clientes, montar carrinhos e enviar o link de checkout. O cliente escolhe o frete e a forma de pagamento no checkout da Nuvemshop, e o pedido aparece na OmniChat com as atualizações de status conforme a loja o processa.
Dúvidas frequentes
O comando `curl` apareceu com o código como `null`.
Isso acontece quando o aplicativo já tinha sido instalado antes: a página só preenche o comando na primeira instalação. Nesse caso, copie o valor do parâmetro `code` que aparece na barra de endereço do navegador depois de aceitar a instalação e use-o no comando do Passo 6.
Depois de aceitar a instalação, a Nuvemshop pediu o login do Portal de Parceiros.
É o comportamento esperado: a página que mostra o código fica dentro do portal. Entre com a mesma conta que criou o aplicativo.
Reinstalei o aplicativo ou alterei as permissões e a integração parou de funcionar.
Qualquer reinstalação gera um token de acesso novo e invalida o anterior. Repita os Passos 5 e 6, depois acesse **Configurações > Integrações > E-Commerce/ERP** na OmniChat, abra a integração Nuvemshop, cole o novo token no campo **Token de acesso** e clique em **Salvar integração**.
Preciso cadastrar webhooks na Nuvemshop?
Não. A OmniChat registra automaticamente as notificações de pedidos e produtos ao salvar a integração, e as remove ao excluí-la.
Os carrinhos abandonados antigos serão importados?
Não. A importação considera apenas os carrinhos abandonados a partir da ativação da opção na integração.
O frete não aparece no carrinho montado pela OmniChat. É normal?
Sim. Na Nuvemshop o frete e o pagamento são escolhidos pelo cliente no checkout da própria loja, ao abrir o link enviado pela OmniChat.