Gerenciar chaves de API
A página API Keys permite criar, visualizar e gerenciar as chaves que seus aplicativos usam para chamar a API do FourA.
Visualizando 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. A participação é o que concede acesso, portanto um membro comum também vê as chaves da organização.
| Coluna | O que mostra |
|---|---|
| Nome | Nome de exibição e, se você definiu uma, a descrição |
| Proprietário | Personal, ou o nome da organização |
| Prefixo da Chave | Os primeiros caracteres da chave, seguidos por uma máscara (pk_live_a1b2••••••••), com um botão Revelar, ou um ícone de cadeado em uma chave legada |
| Status | Ativo ou Inativo |
| Criado | Quando a chave foi criada |
| Último Uso | Quando a chave realizou uma solicitação pela última vez |
Pesquise por nome ou descrição, filtre por Ativo ou Inativo e ordene por Nome, Proprietário, Status, Criado ou Último Uso. A direção da ordenação alterna entre decrescente, crescente e desativada.
O Filtro de Proprietário
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 com esse proprietário, e o mesmo controle em Overview, Metrics, Activity e Proxy acompanha sua escolha, garantindo que as cinco páginas sempre concordem sobre o tráfego que você está visualizando.
Criando 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 |
|---|---|---|
| Nome | Sim | Um rótulo descritivo, por exemplo "production-scraper" ou "staging-test" |
| Descrição | Não | Notas sobre a finalidade de uso desta chave |
| Proprietário | Sim se você estiver em uma organização | Pessoal, 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 de propriedade dela, independentemente de sua função. Esse é o objetivo da configuração: o uso em uma chave de organização é cobrado do proprietário da organização, para que o desenvolvedor não precise de uma chave pessoal que cobre dele silenciosamente 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 exibi-la novamente mais tarde com Reveal. As chaves usam o prefixo pk_live_ e se parecem com pk_live_a1b2c3d4e5f6.... Você receberá um e-mail confirmando que a chave foi criada.
Seu plano define quantas chaves ativas você pode manter: suas chaves pessoais mais as chaves das organizações que você possui. Uma chave criada para uma organização é contabilizada no plano de seu proprietário. Ao atingir o limite, a criação de uma chave é recusada com uma mensagem que informa o número do seu plano; portanto, desative ou exclua uma chave que não usa mais, ou faça um upgrade.
Revelando uma Chave
Clique no ícone de olho ao lado do prefixo mascarado de uma chave para ver seu segredo completo novamente. O painel 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 breve contagem regressiva. Após a contagem regressiva, a caixa de diálogo remove o segredo da página.
Cada revelaçã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 a que ela pertence.
Chaves legadas
Chaves criadas antes do lançamento do recurso de revelação exibem um ícone de cadeado em vez do olho e não podem ser reveladas. Apenas o hash delas foi armazenado, portanto o segredo original não pode ser recuperado. Para migrar uma chave legada, abra o menu de ações e escolha Regenerate. O novo segredo poderá ser revelado a partir de então.
O que cada função pode fazer
Em uma chave pessoal, você pode fazer tudo. Em uma chave da organização, aplicam-se três níveis:
| Ação | Member | Admin | Owner |
|---|---|---|---|
| Usar a chave 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 segredo | Não | Sim | Sim |
| Excluí-la | Não | Sim | Sim |
| Mover para fora da organização | Não | Não | Sim |
Disable e Edit permanecem na linha, mas ficam esmaecidos com uma nota explicando o motivo. Regenerate, Transfer e Delete não aparecem no menu quando sua função não puder utilizá-los. A API recusa as mesmas ações, de modo que uma integração não pode contornar a interface.
A divisão acompanha o impacto de cada ação para as pessoas que compartilham a chave. Renomear é inofensivo. Regenerar ou desativar interrompe a integração de todos os colegas no instante em que ocorre. Mover uma chave para fora a retira da empresa e atribui seu uso ao plano do próprio destinatário, portanto essa ação cabe exclusivamente ao proprietário.
Editando uma chave
Clique em Edit para atualizar o nome e a descrição. A propriedade não é alterada nessa caixa de diálogo: use Transfer.
View Metrics no menu de ações abre a visão geral filtrada para essa chave.
Ativação e desativação
Use Disable ou Enable na linha. Desativar uma chave bloqueia cada request de API que a utilize, e você pode reativá-la a qualquer momento. A alteração entra em vigor em até um minuto.
Regenerando uma chave
Se você suspeitar que uma chave foi exposta, abra o menu de ações e escolha Regenerate. Isso cria um novo segredo para o mesmo ID de chave. O segredo antigo para de funcionar em até um minuto. Nome, proprietário e todas as outras configurações permanecem iguais.
O novo segredo permanece visível após a caixa de diálogo fechar, para que você não precise copiá-lo com perfeição na primeira tentativa.
Transferindo uma chave
Transfer no menu de ações move uma chave entre a propriedade pessoal e da organização sem regenerar o segredo. O ID da chave, suas métricas e seu histórico de atividades são preservados. Apenas o proprietário muda e, com isso, quem é cobrado pelo uso.
| Movimentação | Quem pode fazer |
|---|---|
| Chave pessoal para uma organização | Qualquer pessoa que pertença a essa organização |
| Chave da organização para fora, para você mesmo | O proprietário da organização |
| Entre duas organizações | O proprietário da organização de onde a chave está saindo |
Uma chave movida para uma organização entra no time padrão "Everyone", o que a torna visível para os membros. Uma chave movida para fora sai de todos os times em que estava.
Excluindo uma chave
Abra o menu de ações e selecione Excluir. Excluir uma chave que você já usou a desativa: a chave para de autenticar e permanece na lista como Inativa, mantendo o nome no histórico de Atividade e Métricas. Chaves que nunca foram usadas são removidas em definitivo.
Você receberá um e-mail quando uma chave for excluída.
Chaves da Organização e Faturamento
O uso de uma chave pertencente à 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
- Autenticação: Como as chaves de API funcionam com a API
- Organizações: Funções, membros e acesso compartilhado
- Usage & Limits: Quais chaves são contabilizadas no seu plano
- Visão Geral do Painel: Todas as seções do painel