Chaves de API
Gere, copie, identifique e revogue uma chave de API pessoal do Runner com segurança.
As capturas de tela e as gravações mostram a interface em inglês. Os nomes dos controles podem variar conforme o idioma selecionado.
As chaves de API são segredos pessoais para acesso programático ao Runner. Crie uma apenas para um aplicativo em que você confia, armazene-a com segurança e revogue-a quando não for mais necessária.
O que este guia cobre
Você saberá como criar e salvar o segredo único, identificar chaves existentes sem expô-las e revogar uma chave com confirmação.
Disponibilidade e pré-requisitos
- Chaves API é condicional e aparece apenas quando ativada para sua conta.
- A página indica Cada tecla age como você. As chaves pertencem à sua conta pessoal, não a uma loja.
- Não confunda essas chaves com chaves de API do Analytics somente leitura em Workspace General.
- Nunca coloque uma chave completa em chat, Memória do Agente, uma Habilidade, uma captura de tela, controle de versão ou documentação do produto.
Caminho de entrada
Selecione Configurações → nome da sua conta → Chaves de API. Caso o lançamento esteja ausente, o recurso não está disponível para a conta corrente.
Controles
| Entrada ou botão | Por que é útil | O que acontece a seguir |
|---|---|---|
| Gerar nova chave | Criar uma nova credencial. | Um diálogo abre com um campo Nome opcional. |
| Nome | Identifique o aplicativo mais tarde sem expor o segredo. | O nome aparece na tabela de chaves; em branco cria uma chave sem título. |
| Criar chave | Gere a credencial. | O Runner abre Chave API gerada e exibe o segredo completo uma vez. |
| Ícone de olho | Verifique o valor recém-gerado completo antes de armazená-lo. | O valor único é mostrado ou mascarado no diálogo de sucesso. |
| Ícone de cópia | Copie a nova chave com precisão. | O Runner a copia para a área de transferência e mostra confirmação. |
| Eu salvei a chave | Feche a visualização de segredo único. | O valor completo é limpo do diálogo e não pode ser mostrado novamente lá. |
| Tabela de chave existente | Identifique chaves com segurança. | O Runner mostra Nome, Prefixo, Criado e Último Uso, não o segredo completo. |
| Ícone de exclusão | Revogue uma chave existente. | Uma confirmação explica que a revogação não pode ser desfeita. |
| Revogar | Desative a chave selecionada. | Após o sucesso, a chave é removida da lista e não pode mais autenticar. |
As anotações em inglês indicam os controles. Selecione a imagem para ampliá-la.
A lista vazia é o estado inicial. Nenhum segredo foi gerado ou exibido neste exemplo.
Inspecione a caixa de diálogo antes de criar uma credencial
- Selecione Gerar nova chave.
- Encontre o campo opcional Nome; uma etiqueta como
Reporting integrationajuda a identificar o aplicativo posteriormente. - Selecione Cancelar se estiver apenas explorando. Nenhuma chave será criada até que você selecione Criar chave.
O fluxo de trabalho abaixo se aplica quando as chaves de API estão disponíveis e você está pronto para armazenar um novo segredo.
Gerar e armazenar uma chave
- Abra nome da sua conta → Chaves de API.
- Selecione Gerar nova chave.
- Digite um Nome descritivo, como o aplicativo ou ambiente. Não coloque um segredo no nome.
- Selecione Criar chave.
- Em Chave API gerada, revele a chave apenas se necessário e selecione Copiar.
- Armazene-a em um gerenciador de segredos confiável.
- Confirme o valor armazenado antes de selecionar Eu salvei a chave.
- Use o Prefixo da tabela para identificar a chave mais tarde sem expor o valor completo.
O Runner avisa que a chave completa não será mostrada novamente. Se você fechar o diálogo sem salvá-lo, revogue essa chave e crie uma substituição em vez de tentar recuperar o segredo.
Revogar uma chave
- Corresponda a chave pretendida por Nome e Prefixo.
- Selecione seu ícone de exclusão.
- Revise a confirmação Revogar.
- Selecione Revogar apenas quando o aplicativo dependente estiver pronto para parar de usá-lo.
- Confirme Chave API revogada e remova o segredo antigo do aplicativo.
A revogação é destrutiva e não pode ser desfeita. Crie uma nova chave se o acesso for necessário novamente.
Estados e limites
- Nenhuma chave de API ainda é o estado vazio normal.
- O valor completo de uma nova chave aparece apenas em seu diálogo de sucesso.
- As linhas existentes mostram um prefixo e datas de uso, não uma chave recuperável.
- Nunca em Último Uso significa que o Runner não registrou uma solicitação para essa chave.
- Os botões Criar e Revogar mostram progresso e não devem ser enviados repetidamente.
Solução de problemas
- Se Chaves de API estiver faltando, não use um link direto copiado; o recurso está desativado para esta conta.
- Se a cópia da área de transferência falhar, revele o novo valor e copie-o manualmente para um gerenciador de segredos seguro, depois oculte-o novamente.
- Se você perdeu uma chave completa, revogue sua linha e gere uma substituição.
- Se um aplicativo parar de funcionar após a revogação, atualize-o com uma chave recém-criada; a chave antiga não pode ser restaurada.
- Se a chave errada foi selecionada, Cancele a confirmação e compare Nome e Prefixo novamente.