Menu
Feedback
Comece aqui
Tutoriais
Portal do desenvolvedor

Problemas conhecidos
Diretivas de suporte
Troubleshooting

Perguntas frequentes
Comunicados
Tutoriais
Tutoriais
Explore tutoriais detalhados para operar sua loja VTEX.
Tutoriais
Beta
Chaves de API Beta
Chaves geradas (Beta)
Chaves geradas (Beta)
5 min de leitura

Esta funcionalidade está na fase Beta fechada, o que significa que somente clientes selecionados têm acesso a ela no momento. Caso tenha interesse em implementá-la futuramente, entre em contato com nosso Suporte.

As chaves de API internas são credenciais internas, geradas e administradas por sua conta VTEX. Isso significa que você deve ter acesso a todos os pares de chaves e tokens de API — o equivalente a nomes de usuário e senhas para integrações de API.

A aba Geradas apresenta a listagem de chaves de API criadas pela sua conta.

A página apresenta as informações a seguir em uma tabela:

ColunaDescrição
Chave/NomeChave de API, seguida pelo nome definido durante a criação da chave.
Duração do tokenPrazo de duração do token de API.
Perfil de acessoPerfis de acesso associados à chave de API.
Data de criaçãoData de criação da chave de API.
StatusStatus da chave de API, que pode ser Ativo ou Inativo.

Esta página permite que você realize as seguintes ações:

Gerar chave

Siga as instruções abaixo para criar uma nova 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. Clique em + Gerar chave.

  4. Preencha o campo Identificação da chave com o nome para identificar a chave de API. Este campo é obrigatório.

  5. Selecione os perfis de acesso que serão associados à chave. Por padrão, nenhum perfil de acesso é pré-selecionado.

    Marque apenas os perfis de acesso necessários para a integração que utilizará a chave de API. O uso irrestrito de perfis de acesso muito permissivos aumenta o risco de ataques nas lojas por vazamento de credenciais de login.

  6. Clique em Gerar.

  7. 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. Nesta etapa, a chave já está ativa e disponível para uso.

  8. Clique em Encerrar.

Editar chave gerada

Siga o passo a passo abaixo para realizar alterações em 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 Editar.
  4. Aplique as modificações desejadas, entre as opções abaixo:
  5. Clique em Salvar.

Inativar ou ativar chave gerada

Se uma chave de API que tenha acesso à sua conta for comprometida, você deve inativá-la imediatamente para revogar o acesso à sua conta. Se necessário, você pode gerar uma nova chave para substituir a anterior.

Caso cometa algum erro, é possível reativar a chave de API para restabelecer a integração impactada.

Siga o passo a passo abaixo para inativar ou ativar 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 prossiga para uma das ações a seguir:
    • Inativar: se a chave estiver ativa, clique em Inativar para desabilitá-la. Essa ação vai interromper integrações que utilizem a chave, então utilize-a com cautela. É necessário clicar em Inativar mais uma vez para confirmar a ação.
    • Ativar: se a chave estiver inativa, clique em Ativar para disponibilizá-la para uso.

Apenas reative a chave de API se tiver certeza de que ela não foi comprometida. Quando a chave está ativa, qualquer pessoa com o token de API associado pode ter acesso à sua conta.

Renovar token

O token correspondente a uma chave de API é válido apenas durante o período definido ao configurar a duração de chaves de API. É necessário renovar o token de API antes da duração expirar para manter o acesso contínuo aos recursos e garantir a segurança.

Para isso, siga as instruções descritas em Renovar token de API.

Excluir chave

Chaves de API que não serão mais utilizadas podem ser excluídas. Ao excluir essas chaves, é possível manter a listagem organizada e facilitar o gerenciamento das chaves em uso.

Certifique-se de que a chave de API não está mais em uso por nenhuma integração antes de excluí-la. Este procedimento não pode ser desfeito.

Para excluir uma chave de API de forma definitiva, siga os passos abaixo:

  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 Excluir chave.
  4. Marque a opção Entendo que essa ação não pode ser desfeita.
  5. Para confirmar, clique em Excluir.

Saiba mais

Contribuidores
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Isso foi útil?
Sim
Não
Sugerir edições (GitHub)
Contribuidores
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Nesta página
Ainda tem dúvidas?
Pergunte à comunidade
Encontre soluções e compartilhe ideias na comunidade VTEX.
Junte-se à nossa comunidade
Solicite suporte à VTEX
Para assistência personalizada, entre em contato com nossos especialistas.
Abra um ticket de suporte
GithubDeveloper portalComunidadeFeedback