Quanto mais antigo o token, maior o risco de exposição e de potenciais danos à operação. O procedimento de renovação do token garante a continuidade da segurança da sua loja e minimiza possíveis vulnerabilidades.

Renove o token de API regularmente, se possível antes do alerta para renovação, para preservar a segurança da sua loja.

Siga o passo a passo abaixo para renovar o token de uma chave de API:

1. Na barra superior do Admin VTEX, clique no avatar do seu perfil, marcado pela inicial do seu email, e depois em Configurações da conta > Chaves de API.

2. Certifique-se de que você está na aba Geradas.

3. Na linha de uma chave de API, clique no menu ⋮ e depois em Renovar token.

   Você poderá visualizar o novo token a partir de um link de acesso único, com duração de 24 horas se não houver acesso.

4. Clique em Copiar para copiar o link de acesso único ao novo token para a área de transferência. Este link será exibido apenas uma vez.

5. Na seção Excluir token antigo, marque uma das opções a seguir:

   • Depois: será necessário excluir manualmente o token antigo assim que o novo token estiver em uso nas integrações. Os dois tokens estarão válidos e funcionais até a exclusão do antigo. Na listagem da aba Geradas, na coluna Duração do token, vão aparecer os prazos de duração dos dois tokens, até o antigo ser excluído.

   • Agora: o token antigo será excluído do sistema ao finalizar o processo de renovação e apenas o novo token será válido.

   Caso a página seja fechada antes de selecionar uma forma de exclusão neste passo, a opção Depois será aplicada, ou seja, você precisará excluir o token antigo manualmente.

6. Clique em Finalizar.

7. Acesse o link copiado ou compartilhe-o com a pessoa que vai utilizar o novo token. O link pode ser acessado apenas uma vez e tem duração de 24 horas se não houver acesso.

8. Clique em Copiar para copiar o token da API para a área de transferência. Esse segredo será exibido apenas uma vez. Salve-o em um local seguro.

Ao finalizar a renovação, não será possível renovar o token novamente antes do link de acesso único ser acessado ou expirar no prazo de 24 horas. Se necessário, você pode desfazer a renovação do token enquanto o link ainda for válido.

Se o link de acesso único expirar antes de ser utilizado, repita o passo a passo para renovar o token e gerar um novo link.

A URL oficial para acessar o token segue sempre o formato share.vtex.com/credentials/{token}. O {token} é um identificador aleatório gerado no momento da criação ou renovação da chave. Verifique o formato do link antes de acessá-lo para evitar riscos de phishing ou acesso a páginas maliciosas.

Certifique-se de que o token antigo não está mais em uso por nenhuma integração antes de excluí-lo. Este procedimento não pode ser desfeito.

Siga as instruções abaixo para excluir manualmente um token antigo, após a renovação. Este procedimento é possível apenas quando a opção de excluir o token antigo Depois for selecionada ao renovar um token.

1. Na barra superior do Admin VTEX, clique no avatar do seu perfil, marcado pela inicial do seu email, e depois em Configurações da conta > Chaves de API.

2. Certifique-se de que você está na aba Geradas.

3. Na linha de uma chave de API com o alerta Exclusão pendente - Token antigo, clique no menu ⋮ e depois em Excluir token antigo.

   

4. Para confirmar, clique em Excluir.

Este procedimento é possível apenas enquanto o token antigo não tiver sido excluído. Se o token antigo tiver sido excluído, será necessário renovar o token novamente ou excluir a chave de API.

Se você renovou o token por engano ou esqueceu de copiar o novo token gerado, siga os passos abaixo para desfazer a renovação.

1. Na barra superior do Admin VTEX, clique no avatar do seu perfil, marcado pela inicial do seu email, e depois em Configurações da conta > Chaves de API.
2. Certifique-se de que você está na aba Geradas.
3. Na linha de uma chave de API, clique no menu ⋮ e depois em Desfazer renovação.
4. Para confirmar, clique em Desfazer.

• Chaves de API
• Configurar alerta para renovar tokens de API
• Chaves geradas