Uma chave de API é como uma senha que permite que diferentes sistemas se comuniquem entre si de forma segura. Para e-commerces, ela é usada para conectar sua loja online a outros serviços, como plataformas de pagamento, ferramentas de marketing e o nosso programa de fidelidade. Com essa chave, automatizamos processos, como o pontuação de clientes e cadastro de clientes, facilitando a administração do seu programa e a experiência do cliente. Para saber como gerar, siga os passos seguintes.
Passo 1 - Em sua conta Vtex na seção Segurança, clique em Gerar appKey e appToken.
- AppKey: AppKey e AppToken são credenciais de autenticação usadas para acessar as APIs da VTEX. A AppKey identifica o aplicativo, enquanto o AppToken valida as permissões de acesso. Juntas, elas garantem uma comunicação segura com a plataforma.
Passo 2 - Insira um nome para o par de appKey e appToken que você está criando e clique em Gerar novos tokens .
Passo 3 - No campo exibido em seguida, será apresentado o token. Por uma questão de segurança, ele é exibido apenas uma vez! Copie esse token e guarde-o em um local seguro.
⚠️Importante: Não se esqueça de dar permissão para gestão de clientes, pedidos, promoções e cupons para essas chaves. (Clique aqui para acessar a página) e vá em Gerenciar permissões de chaves de aplicação, para saber como como dar permissões as chaves.
Passo 4 - Após criado o AppToken, agora precisamos do AppKey. Na seção Segurança da aba Contas, copie a appKey desejada, que se encontra na coluna Chave de aplicação.
Passo 5 - No painel do program de fidelidade clique em Mais > Configurações.
Passo 6 - Procure por Integração e selecione sua plataforma de e-commerce que é a VTEX.
Passo 8 - Agora você irá preencher as seguintes informações:
- Informe sua chave de API (AppKey) e Token (AppToken): Coloque aqui as chaves geradas nos passos anteriores.
- Linguagem;
- Tempo pontuar:
Estabeleça o período após a atualização do pedido para o status escolhido na integração, no qual os pontos serão creditados aos clientes. Por exemplo: Se definido 30 dias, os pontos dos clientes serão contabilizados somente 30 dias após o pedido ter sido atualizado para o status da integração.
- Informe o site de sua loja:
é necessário fornecer a URL do seu domínio personalizado, que direciona para sua loja na plataforma VTEX. Exemplo: https://www.seudominiopersonalizado.com ou https://loja.seudominiopersonalizado.com
- Subdomínio:
Indique o nome da sua loja, que precede o domínio da VTEX (myvtex.com). Exemplo: nomedaloja.myvtex.com;
- Autenticação única:
Ao ativar esta opção, o cliente que já estiver registrado no programa de Fidelidade poderá acessar os benefícios diretamente ao entrar na loja virtual, sem precisar fazer login novamente no widget/botão.
- Informe a URL (link) para cadastro de clientes de sua loja: Forneça o URL de cadastro do site da sua loja. Isso é crucial se sua loja estiver no plano que inclui o widget enterprise, pois, se o cliente não conseguir realizar o cadastro no programa, ele será redirecionado para esse link.
- Informe os SKU's/IDs dos produtos que deseja com o prêmio: Este campo é para ser utilizado caso não queria que todo o seu catálogo de produtos fique disponível como prêmio.
- Qual é o último status do pedido após ser entregue ao cliente: Mencione em qual status o pedido deve estar para nosso sistema pontuar seu cliente.
Passo 10 - Para concluir todas as configurações do programa selecione as opções mostradas e salve os dados.
💡 Importante: Ao escolher a opção de Ativar Integração, o sistema importará seus clientes e vendas e iniciará o envio de e-mails para eles. Portanto, ative essa opção apenas após finalizar todas as configurações do seu programa de fidelidade.
- Ativar integração: Clique para ativar o programa;
- Cadastrar clientes: Clique para importar os seus clientes para o programa de fidelidade;
- Cadastrar vendas: Clique para permitir importar as vendas do e-commerce, dessa maneira sua base de clientes será pontuada;
- Seus produtos são presentes: Escolha esta opção se os produtos forem oferecidos como cupons de presente e se você tiver inserido os SKU's no passo anterior;
- Importar produtos da API: Escolha esta opção somente se anteriormente tiver marcado "seus produtos são presentes", pois esses produtos serão oferecidos como prêmios aos seus clientes.
- Resgate de produtos manual (opcional): Selecione apenas se tiver registrado produtos como prêmios e quiser que sejam enviados diretamente para aprovação.
Por fim, clique em Salvar dados para que tudo seja salvo.
💡 Importante: Os presentes são as recompensas que seus clientes ganharão ao atingirem uma certa pontuação. Ao resgatá-los, eles recebem um código de cupom que deve ser inserido no checkout, garantindo assim o recebimento do presente, conforme demonstrado abaixo.
Pronto! Agora suas vendas e seus clientes serão cadastrados no programa em até 72h após o cadastro no e-commerce.