Chaves de API

3 min de leitura

Para cada integração via API utilizada para conectar sua conta VTEX com sistemas externos, será necessária a criação de uma chave de API, também conhecida em inglês como API key. Para cada chave, existe um token de API (ou API token), que funciona como uma senha para uso daquela credencial.

Estas credenciais de autenticação são usadas para garantir o acesso seguro aos dados que você deseja compartilhar com as integrações, sem expor sua conta a aplicações ou usuários não autorizados.

Para que uma chave de API faça solicitações de API à sua conta com sucesso, ela precisa estar ativa e ter perfis de acesso especificando os recursos da conta que tem permissão para acessar.

Tipos de chaves de API

Existem dois tipos de chaves de API: internas ou externas. Essa definição depende de qual conta cria, gerencia e utiliza a credencial.

Chaves internas

As chaves de API internas são credenciais 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.

Chaves externas

As chaves de API externas são credenciais geradas e administradas por outras contas VTEX. Ao adicionar perfis de acesso às chaves de API — o equivalente a nomes de usuário — fornecidas por terceiros, você pode permitir que eles acessem recursos específicos na sua conta.

Gerenciar chaves de API

A página Chaves de API no Admin VTEX permite gerenciar as chaves de API com acesso à sua loja. Confira nos guias a seguir mais detalhes sobre as informações e ações disponíveis a partir desta página:

Exportar chaves de API: fazer download de uma planilha com informações sobre as chaves de API geradas e externas.
Configurações: definir o período para recomendação de renovação dos tokens. Quando um token atingir o limite estabelecido, a interface alertará sobre a necessidade de renovação. Essa configuração se aplica a todos os tokens de chave.

O token não expira após o prazo definido. A configuração determina apenas quando a interface vai recomendar a renovação.

${"base64":" ","img":{"width":822,"height":452,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":45166,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/pt/tutorials/gerenciamento-da-conta/chaves-de-api/chaves-de-api_1.png"}}$
Chaves geradas: permite gerenciar chaves de API criadas e administradas por sua conta VTEX.

${"base64":" ","img":{"width":1920,"height":1036,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":282720,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/pt/tutorials/gerenciamento-da-conta/chaves-de-api/chaves-de-api_2.png"}}$
Chaves externas: permite gerenciar chaves de API criadas e administradas por outras contas VTEX, com acesso a recursos específicos na sua conta.

${"base64":" ","img":{"width":1132,"height":358,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":32381,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/pt/tutorials/gerenciamento-da-conta/chaves-de-api/chaves-de-api_3.png"}}$

Requisitos para gerenciar chaves de API

Para gerenciar chaves de API, é obrigatório ter o perfil de acesso User Administrator - RESTRICTED ou um perfil customizado com os recursos a seguir:

View API Keys (visualizar, filtrar, buscar, ordenar e exportar chaves de API geradas e externas)
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 sobre cada recurso em Recursos do License Manager.