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 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.
A aba Terceiras apresenta a listagem de chaves de API de terceiros adicionadas à sua conta.
A página apresenta as seguintes informações em uma tabela:
| Coluna | Descrição |
|---|---|
| Chave/Proprietário | Chave de API, seguida pelo nome da conta terceira proprietária da chave. |
| Perfil de acesso | Perfis de acesso associados à chave de API de terceiros. |
| Data de adição | Data de adição da chave de API de terceiros. |
| Status | Status da chave de API de terceiros, que pode ser Ativo ou Inativo. |
Esta página permite que você realize as seguintes ações:
Adicionar chave terceira
Para adicionar uma chave de terceiros à sua conta, siga os passos abaixo:
-
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.
-
Clique na aba Terceiras.
-
Clique em
+ Adicionar chave. -
Preencha o campo Identificação da chave com o nome para identificar a chave de API.
-
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.
-
Clique em
Adicionar.
Editar chave terceira
Siga o passo a passo abaixo para realizar alterações em uma chave de API de terceiros:
- 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.
- Clique na aba Terceiras.
- Na linha de uma chave de API, clique no menu ⋮ e depois em
Editar. - Modifique a seleção de perfis de acesso associados à chave de API conforme desejado.
- Clique em
Salvar.
Remover chave terceira
Para remover uma chave de API de terceiros, siga as instruções abaixo:
- 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.
- Clique na aba Terceiras.
- Na linha de uma chave de API, clique no menu ⋮ e depois em
Remover. - Para confirmar, clique em
Remover.