Gerenciar chaves de API
A página API Keys permite que você crie, visualize e gerencie as chaves que suas aplicações usam para chamar a FourA API.
Visualizando suas chaves
A página mostra todas as chaves às quais você tem acesso:
- Personal keys que você criou diretamente.
- Organization keys se você for um proprietário ou administrador de uma organização, ou se uma chave que você possui foi transferida para uma de suas organizações.
Cada linha na tabela mostra:
| Coluna | O que ela mostra |
|---|---|
| Name | Nome de exibição e (opcional) descrição |
| Key | Prefixo mascarado (por exemplo, pk_live_••••••••) com um botão Reveal ao lado |
| Owner | Personal para chaves pessoais, ou o nome da organização para chaves de organização |
| Status | Active ou Inactive |
| Created | Quando a chave foi criada |
| Last Used | Quando a chave fez uma solicitação pela última vez |
Use a caixa de pesquisa para filtrar por nome ou descrição, e o filtro de status para mostrar apenas chaves ativas ou inativas. Todos os cabeçalhos das colunas são ordenáveis.
Criando uma chave
Clique em Create Key e preencha:
| Campo | Obrigatório | Descrição |
|---|---|---|
| Name | Sim | Um rótulo descritivo (por exemplo, "production-scraper" ou "staging-test") |
| Description | Não | Notas sobre para que esta chave é usada |
| Owner | Sim, se você estiver em uma organização | Pessoal, ou uma das organizações às quais você pertence. O seletor aparece apenas quando você tem pelo menos uma organização. |
A chave completa é mostrada uma vez logo após a criação em um diálogo pronto para cópia. Você também pode trazê-la de volta mais tarde usando o Reveal (veja abaixo).
As chaves usam o prefixo pk_live_ e se parecem com pk_live_a1b2c3d4e5f6.... Você receberá uma confirmação por e-mail quando uma nova chave for criada.
Revelando uma chave
Clique no ícone de olho ao lado do prefixo mascarado de uma chave para ver seu segredo completo novamente. O painel pede que você confirme, e então abre um diálogo com a chave em formato de texto simples, um botão de cópia e uma breve contagem regressiva. Após a contagem regressiva, o diálogo apaga o segredo da página.
Cada revelação é registrada no log de auditoria porque expõe uma credencial ativa.
Chaves antigas
As chaves criadas antes do recurso de revelação ser lançado mostram um ícone de cadeado em vez do olho e não podem ser reveladas. Apenas o hash delas foi armazenado, portanto, o segredo original é irrecuperável. Para converter uma chave antiga, clique no menu de ações e escolha Regenerate. O novo segredo será revelável a partir de então.
Quem pode revelar
| Papel | Pode revelar |
|---|---|
| Proprietário da chave | Sim |
| Proprietário ou administrador da organização (para chaves de organização) | Sim |
| Qualquer outra pessoa | Não |
Editando uma chave
Clique em Edit em qualquer linha para atualizar o nome de exibição e a descrição. A propriedade (pessoal vs organização) não é alterada aqui. Use Transfer abaixo para mover uma chave entre proprietários.
Ativando e desativando
Use o botão Disable / Enable na linha para alternar o status de uma chave. A desativação de uma chave bloqueia todas as solicitações de API que a utilizam. Você pode reativá-la a qualquer momento. A mudança tem efeito em poucos segundos.
Regenerando uma chave
Se você suspeita que uma chave foi comprometida, abra o menu de ações (o botão de três pontos) e escolha Regenerate. Isso cria um novo secret para o mesmo key ID. O secret antigo para de funcionar imediatamente. Nome, atribuição de org e outras configurações continuam os mesmos.
O novo secret permanece visível após o fechamento da caixa de diálogo, então você não precisa copiá-lo perfeitamente na primeira tentativa.
Transferindo uma Chave
Cada linha possui uma ação Transfer no menu. Use-a para mover uma chave entre a propriedade pessoal e da organização sem regenerar o secret. O key ID, suas métricas e seu histórico de atividade são preservados, apenas o proprietário muda.
Casos comuns:
- Mover uma chave pessoal que você criou para um projeto compartilhado para a org para que um colega de equipe possa gerenciá-la depois de você.
- Reatribuir uma chave da org de volta para você caso o projeto seja separado.
Você pode transferir uma chave que possui (pessoal) para qualquer org onde você é owner ou admin, e pode transferir uma chave de org que você administra para si mesmo ou entre orgs que você administra.
Excluindo uma Chave
Abra o menu de ações e escolha Delete. Excluir uma chave que você já usou faz um soft-delete: a chave para de autenticar, mas seu histórico de Activity e Metrics permanece intacto. Chaves que nunca foram usadas podem sofrer hard-delete.
Você receberá uma notificação por e-mail quando uma chave for excluída.
Chaves de Organização
Chaves de propriedade de uma organização são visíveis para owners e admins da org. Membros sem a função de owner ou admin não as veem.
O uso em uma chave de propriedade da org é contabilizado no plano do owner da org.
Relacionados
- Authentication: Como as chaves de API funcionam com a API
- Organizations and Teams: Configurando o acesso compartilhado
- Dashboard Overview: Todas as seções do painel