Menu
Feedback
Comece aqui


Comunicados
Comunicados
Dezembro
Chaves de API: nova experiência com foco em usabilidade e segurança
Photo of the author
Júlia Rabello
Publicado em03/12/2024
Última atualização em05/02/2025
4 min de leitura

Introduzimos uma nova experiência de gerenciamento de chaves de API para proporcionar um controle mais eficiente sobre suas credenciais.

A atualização inclui uma interface otimizada para facilitar a gestão e novas funcionalidades voltadas para segurança, como a definição da duração de tokens, a renovação de tokens e a exclusão de chaves não utilizadas.

{"base64":"  ","img":{"width":1918,"height":936,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":164553,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/pt/announcements/2024/dezembro/2024-12-03-chaves-de-api-nova-experiencia-com-foco-em-usabilidade-e-seguranca_1.png"}}

O que mudou?

Veja todas as novidades a seguir:

AlteraçãoDescrição
NomenclaturaAlteramos a nomenclatura chaves de aplicação para chaves de API na interface do Admin.
DesignA interface de gerenciamento, criação e edição de chaves de API foi redesenhada para uma experiência mais intuitiva e eficiente.
Separação de chavesChaves geradas internamente e chaves de terceiros agora são separadas em abas distintas para facilitar o gerenciamento de cada tipo de chave.
Duração de tokensTodos os tokens de API gerados internamente agora têm uma duração padrão de 3 meses, que pode ser alterada para 6 meses na interface.A configuração se aplica a todos os tokens novos e existentes gerados na conta e terá a data de criação da chave como referência para a contagem da duração.A duração de tokens terceiros é visível e configurável somente pela conta que criou o token.Quando os tokens gerados se tornarem obsoletos, os lojistas serão informados na interface. Não há impacto no uso do token — o status obsoleto é apenas um recurso visual para indicar o estado do token e sugerir a renovação.Saiba mais em Configurar a duração de chaves de API.
Renovação de tokensAgora é possível renovar tokens de chaves geradas na conta. A funcionalidade permite optar por excluir o token antigo imediatamente ou em outro momento.Ao optar por excluir em outro momento, os dois tokens estarão válidos e funcionais até a exclusão do antigo, permitindo que o lojista atualize o token utilizado em integrações sem prejudicar a operação. Saiba mais em Renovar token de API.
Exclusão de chaves de APIOs lojistas agora podem excluir chaves de API que não serão mais utilizadas.
Permissões específicasNovas permissões necessárias para gerenciar chaves de API:View API Keys (visualizar, filtrar, buscar e ordenar chaves de API geradas e terceiras)Edit API Keys (criar, excluir, mudar o status e adicionar ou remover permissões de chaves de API)Renew API Token (visualizar e renovar tokens de chaves geradas)Edit API Keys settings (editar configuração da duração de tokens de chaves geradas)Saiba mais em Recursos do License Manager.Os usuários com as permissões para controle de usuários e perfis de acesso vão obter as novas permissões de forma automática, conforme a tabela: Usuários com…Recebem automaticamente…Get account by identifierView API KeysGet paged usersView API KeysGet paged rolesView API KeysFind user by emailView API KeysSave userEdit API KeysOwner - Super AdminEdit API Keys settingsUser Administrator - RESTRICTEDRenew API Token

Por que fizemos essa mudança?

O objetivo da nova experiência é proporcionar mais controle e segurança sobre suas chaves de API, com facilidade de uso. A interface agiliza a gestão de diferentes tipos de chaves e otimiza a visibilidade das informações.

Além disso, a configuração da duração de tokens adiciona uma camada extra de segurança, enquanto as opções de renovação garantem que a operação da loja não seja impactada.

O que precisa ser feito?

Siga os passos abaixo para acessar a nova experiência:

  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. Clique em Testar nova experiência.

É possível voltar para a versão anterior da página ao clicar em Voltar à versão anterior.

Para mais informações, acesse a documentação relacionada:

Isso foi útil?
Sim
Não
Sugerir edições (GitHub)
Nesta página
Ainda tem dúvidas?
Pergunte à comunidade
Encontre soluções e compartilhe ideias na VTEX Community
Junte-se à nossa comunidade
Solicite suporte à VTEX
Receba assistência personalizada com nossos especialistas
Abra um ticket de suporte
GitHubDeveloper PortalComunidadeFeedback