Exportar chaves de API
2 min de leitura
A página Chaves de API permite exportar informações de todas as chaves geradas e as chaves externas relacionadas à conta para um arquivo XLSX
.
Antes de começar
Para a exportação, é obrigatório ter o perfil de acesso User Administrator - RESTRICTED ou um perfil customizado com o recurso View API Keys.
Instruções
Siga as instruções para exportar as chaves:
- Na barra superior do Admin VTEX, clique no avatar do seu perfil, marcado pela inicial do seu email.
- Clique em Configurações da conta > Chaves de API.
- Clique em
Exportar
. O download do arquivo será iniciado instantaneamente.
A seguir, confira as informações disponíveis na planilha.
Aba Geradas
Coluna | Descrição |
---|---|
id | Código de identificação da chave de API. |
keyName | Chave de API. |
roles | Perfis de acesso associados à chave de API. |
label | Nome da chave de API, definido durante a criação da chave. |
creationDate | Data de criação da chave de API. |
creationDateToken | Caso a chave tenha um único token atual associado a ela, esta data é o momento de criação deste token. Caso a chave esteja em processo de renovação, há dois tokens associados a ela. Neste caso, esta data é o momento de criação do token que está sendo substituído pelo novo (o token que existia antes de iniciar a renovação). |
creationDateNewToken | Caso a chave tenha um único token associado, este campo terá valor nulo. Caso a chave esteja em processo de renovação, há dois tokens associados a ela. Neste caso, o campo representa a data de criação do novo token que substituirá o antigo (em outras palavras, a data na qual iniciou a renovação). |
status | Status da chave de API, que pode ser Active (Ativo) ou Inactive (Inativo). |
Aba Externas
Coluna | Descrição |
---|---|
id | Código de identificação da chave de API. |
keyName | Chave de API. |
roles | Perfis de acesso associados à chave de API. |
account | Nome da conta terceira proprietária da chave. |
addedDate | Data de adição da chave de API de terceiros. |
status | Status da chave de API, que pode ser Active (Ativo) ou Inactive (Inativo). |