Gerenciar chaves de API
A página de chaves de API permite criar, visualizar e gerenciar as chaves que suas aplicações usam para chamar a API do FourA.
Visualizar suas chaves
A página mostra todas as chaves às quais você tem acesso:
- Chaves pessoais que você criou diretamente.
- Chaves de organização se você for proprietário ou administrador da organização.
- Chaves de equipe compartilhadas com você por meio da participação em uma equipe.
Cada linha na tabela mostra:
| Coluna | O que mostra |
|---|---|
| Nome | Nome de exibição e descrição (opcional) |
| Chave | Prefixo mascarado (ex: pk_live_••••••••) com um botão Reveal ao lado |
| Proprietário | ME para chaves pessoais, TEAM para chaves de organização ou compartilhadas com a equipe |
| IP Allowlist | IPs restritos se definidos, ou "Todos os IPs" se irrestrito |
| Expira em | Data de expiração se definida, ou "Nunca" |
| Status | Ativo ou Inativo |
| Criado em | Quando a chave foi criada |
| Último uso | Quando a chave fez um request pela última vez |
Use a caixa de busca para filtrar por nome ou descrição, e o filtro de status para mostrar apenas chaves ativas ou inativas.
Criar uma chave
Clique em Create Key e preencha:
| Campo | Obrigatório | Descrição |
|---|---|---|
| Nome | Sim | Um rótulo descritivo (ex: "production-scraper" ou "staging-test") |
| Descrição | Não | Notas sobre para que esta chave é usada |
Se você pertence a uma organização, também pode atribuir a chave a essa organização em vez de sua conta pessoal.
A chave completa é exibida apenas uma vez logo após a criação em uma caixa de diálogo pronta para cópia. Você também pode visualizá-la novamente mais tarde via Reveal (veja abaixo), desde que a chave tenha sido criada após o lançamento do recurso de revelação.
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.
Revelar uma chave
Clique no ícone de olho ao lado do prefixo mascarado de uma chave para ver seu segredo completo novamente. O dashboard solicita sua confirmação e, em seguida, abre uma caixa de diálogo com a chave em texto simples, um botão de cópia e uma contagem regressiva de 15 segundos. Após a contagem regressiva, a caixa de diálogo limpa o segredo da página.
Cada revelação é registrada no log de auditoria porque expõe uma credencial ativa.
Chaves legadas
As chaves criadas antes do lançamento deste recurso 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 substituir uma chave legada, clique no menu de ações e escolha Regenerate. O novo segredo poderá ser revelado a partir de então.
Quem pode revelar
| Função | Pode revelar |
|---|---|
| Proprietário da chave | Sim |
| Proprietário / admin da organização (para chaves de organização) | Sim |
Membro da equipe com permissão write ou admin |
Sim |
Membro da equipe com permissão read |
Não |
Editar uma chave
Clique em Edit em qualquer linha para atualizar:
- Nome de exibição e descrição
- IP allowlist (um IP por linha; deixe em branco para permitir qualquer IP de origem)
- Data de expiração (deixe em branco para não expirar)
Outras configurações (atribuição de organização, proprietário) não são editáveis. Crie uma nova chave se precisar de uma propriedade diferente.
Ativar e desativar
Use o botão Disable / Enable na linha para alternar o status de uma chave. Desativar uma chave bloqueia todos os requests de API que a utilizam. Você pode reativá-la a qualquer momento. A alteração entra em vigor em poucos segundos.
Regenerar uma chave
Se você suspeitar 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 segredo para o mesmo ID de chave. O segredo antigo para de funcionar imediatamente. Todas as outras configurações (nome, atribuição de organização, IP allowlist, expiração) permanecem as mesmas.
O novo segredo continua revelável após o fechamento da caixa de diálogo, para que você não precise copiá-lo perfeitamente na primeira tentativa.
Excluir uma chave
Abra o menu de ações e escolha Delete. Por padrão, a exclusão desativa a chave (soft delete). Você pode removê-la permanentemente na caixa de diálogo de confirmação.
Você receberá uma notificação por e-mail quando uma chave for excluída.
Chaves de organização
As chaves criadas sob uma organização são compartilhadas com os membros da organização com base em suas funções:
- Proprietários e administradores visualizam e editam todas as chaves da organização.
- Membros visualizam apenas as chaves atribuídas às equipes às quais pertencem.
As chaves de organização são adicionadas automaticamente à equipe padrão da organização no momento da criação.
Permissões de chave por meio de equipes
As equipes controlam quem pode acessar quais chaves. Cada atribuição de chave de equipe possui um nível de permissão:
| Permissão | Visualizar chave | Revelar | Editar configurações da chave |
|---|---|---|---|
| read | Sim | Não | Não |
| write | Sim | Sim | Sim |
| admin | Sim | Sim | Sim |
Relacionado
- Autenticação: Como as chaves de API funcionam com a API
- Organizações e Equipes: Configurando o acesso compartilhado
- Visão Geral do Dashboard: Todas as seções do dashboard