Gerenciar chaves de API
A página API Keys permite que você crie, visualize e gerencie as chaves que seus aplicativos usam para chamar a FourA API.
Como visualizar suas chaves
A página mostra todas as chaves às quais você tem acesso: suas chaves pessoais e todas as chaves pertencentes a uma organização da qual você faz parte. O acesso é concedido pela condição de membro, portanto, um membro comum também vê as chaves da organização.
| Coluna | O que ela mostra |
|---|---|
| Name | Nome de exibição e, se você tiver definido uma, a descrição |
| Owner | Personal, ou o nome da organização |
| Key Prefix | Prefixo mascarado (pk_live_••••••••) com um botão Reveal, ou um ícone de cadeado em uma chave legada |
| Status | Ativo ou Inativo |
| Created | Quando a chave foi criada |
| Last Used | Quando a chave fez uma request pela última vez |
Pesquise por nome ou descrição, filtre por Ativo ou Inativo e ordene por qualquer cabeçalho. A direção da ordenação alterna entre decrescente, crescente e desativada.
O filtro Owner
Se você pertencer a pelo menos uma organização, um menu suspenso Owner aparecerá ao lado da caixa de pesquisa: Everything, Personal ou uma entrada por organização. Ele restringe a lista às chaves desse proprietário, e o mesmo controle em Overview, Metrics, Activity e Proxy acompanha a sua escolha, mantendo as cinco páginas sempre sincronizadas sobre o tráfego que você está visualizando.
Como criar uma chave
Clique em Create Key acima da lista (Create API key na página vazia antes da sua primeira chave) e preencha:
| Campo | Obrigatório | Descrição |
|---|---|---|
| Name | Sim | Um rótulo descritivo, por exemplo "production-scraper" ou "staging-test" |
| Description | Não | Observações sobre a finalidade desta chave |
| Owner | Sim, se você estiver em uma organização | Personal, ou qualquer organização da qual faça parte. O seletor só aparece quando você tem pelo menos uma. |
Qualquer membro de uma organização pode criar uma chave pertencente a ela, independentemente de sua função. Esse é o objetivo da configuração: o uso de uma chave de organização é cobrado do proprietário da organização, de modo que o desenvolvedor não precisa de uma chave pessoal que cobre discretamente dele em vez da empresa.
A chave completa é exibida uma vez logo após a criação em uma caixa de diálogo pronta para cópia. Você pode visualizá-la novamente mais tarde com Reveal. As chaves usam o prefixo pk_live_ e têm o formato pk_live_a1b2c3d4e5f6.... Você receberá um e-mail confirmando a criação da chave.
Como revelar uma chave
Clique no ícone de olho ao lado do prefixo mascarado de uma chave para ver seu secret completo novamente. O painel solicita que você confirme e, em seguida, abre uma caixa de diálogo com a chave em texto sem formatação, um botão de cópia e uma breve contagem regressiva. Após a contagem regressiva, a caixa de diálogo remove o secret da página.
Cada visualização é registrada no log de auditoria, pois expõe uma credencial ativa.
Qualquer pessoa com quem a chave for compartilhada pode revelá-la: seu proprietário pessoal ou qualquer membro da organização à qual ela pertence.
Chaves legadas
Keys criadas antes do lançamento do recurso de visualização exibem um ícone de cadeado em vez do olho e não podem ser reveladas. Apenas o hash delas foi armazenado, portanto o secret original é irrecuperável. Para migrar uma key legada, abra o menu de ações e selecione Regenerate. O novo secret poderá ser revelado a partir de então.
O que cada função pode fazer
Em uma key pessoal, você pode fazer tudo. Em uma key de organização, três níveis se aplicam:
| Ação | Member | Admin | Owner |
|---|---|---|---|
| Usar a key e revelá-la | Sim | Sim | Sim |
| Renomeá-la, editar a descrição | Sim | Sim | Sim |
| Ativá-la ou desativá-la | Não | Sim | Sim |
| Regenerar o secret | Não | Sim | Sim |
| Excluí-la | Não | Sim | Sim |
| Movê-la para fora da organização | Não | Não | Sim |
Disable e Edit permanecem na linha, mas ficam esmaecidos com uma observação explicando o motivo. Regenerate, Transfer e Delete não aparecem no menu quando a sua função não pode usá-los. A API recusa as mesmas ações, portanto uma integração não pode burlar a interface.
A divisão segue o impacto que cada ação causa para as pessoas que compartilham a key. Renomear é inofensivo. Regenerar ou desativar interrompe a integração de todos os colegas no instante em que acontece. Mover uma key para fora a remove da empresa e coloca o uso dela no plano próprio de quem a transferiu, portanto essa ação é exclusiva do owner.
Editar uma key
Clique em Edit para atualizar o nome e a descrição. A propriedade não é alterada nesta caixa de diálogo: use Transfer.
View Metrics no menu de ações abre a Overview filtrada para essa key.
Ativar e desativar
Use Disable ou Enable na linha. Desativar uma key bloqueia todas as requests de API que a utilizam, e você pode reativá-la a qualquer momento. A alteração entra em vigor em poucos segundos.
Regenerar uma key
Se você suspeitar que uma key foi exposta, abra o menu de ações e selecione Regenerate. Isso cria um novo secret para o mesmo ID de key. O secret antigo para de funcionar imediatamente. Nome, owner e todas as outras configurações permanecem iguais.
O novo secret continua disponível para visualização após fechar a caixa de diálogo, para que você não precise copiá-lo perfeitamente na primeira tentativa.
Transferir uma key
Transfer no menu de ações move uma key entre a propriedade pessoal e a da organização sem regenerar o secret. O ID da key, suas métricas e seu histórico de atividades são preservados. Apenas o owner muda e, com isso, a quem o uso é faturado.
| Movimentação | Quem pode fazer |
|---|---|
| Key pessoal para uma organização | Qualquer pessoa que pertença a essa organização |
| Key da organização para fora, para você | O owner da organização |
| Entre duas organizações | O owner da organização de onde a key está saindo |
Uma key que é movida para uma organização entra na equipe padrão "Everyone", o que a torna visível para os membros. Uma key movida para fora sai de todas as equipes das quais fazia parte.
Excluir uma key
Abra o menu de ações e escolha Delete. Excluir uma chave usada anteriormente a desativa: a chave para de autenticar e permanece na lista como Inactive, mantendo o histórico de Activity e Metrics com seu respectivo nome. Chaves que nunca foram usadas são removidas em definitivo.
Você receberá um e-mail quando uma chave for excluída.
Chaves de Organização e Faturamento
O uso de uma chave pertencente a uma organização é contabilizado no plano do proprietário da organização, independentemente de quem disparou a request. A página Usage & Limits do proprietário contabiliza essas chaves junto com as pessoais e separa as duas.
Relacionado
- Authentication: Como as API keys funcionam com a API
- Organizations: Funções, membros e acesso compartilhado
- Usage & Limits: Quais chaves são contabilizadas no seu plano
- Dashboard Overview: Todas as seções do painel