Conta e cobrança

Chaves de API

Como criar, renomear, expirar e remover uma chave de API para poder chamar a API do FlowHunt a partir do seu próprio código.

Uma chave de API permite que um script ou aplicação chame a API do FlowHunt como o seu espaço de trabalho sem fazer login. As chaves pertencem ao espaço de trabalho, não a você pessoalmente, portanto as chamadas feitas com uma delas agem sobre esse espaço de trabalho.

Criar uma chave#

  1. Abra a aba API Keys

    Clique em Settings na área da conta e, em seguida, na aba API Keys.

  2. Adicione a chave

    Clique em Add API Key. Na caixa de diálogo Create API Key, insira um Name que indique onde a chave é usada, por exemplo “Script de exportação noturna”. Clique em Add API Key para confirmar.

  3. Copie-a agora

    A próxima caixa de diálogo mostra a chave com um botão Copy to clipboard. O FlowHunt mostra a chave completa apenas uma vez e não pode mostrá-la novamente. Guarde-a em um gerenciador de segredos ou em uma variável de ambiente, nunca em código que você envia para o repositório.

Se você perder uma chave, crie uma nova e remova a antiga.

Usar a chave#

A mesma caixa de diálogo tem Try API key, que abre a referência da API em api.flowhunt.io/docs. A referência lista todos os endpoints e mostra como enviar a chave. Um botão PHP SDK leva ao pacote PHP do FlowHunt para projetos em PHP.

Gerenciar suas chaves#

A lista API Keys mostra o Name de cada chave, uma versão mascarada da chave, quando ela foi Last used e sua data Valid to.

  • Renomear ou definir uma expiração. Abra uma chave e altere seu Name ou a data Valid to, depois clique em Update API Key. A data de expiração só pode ser definida após a criação.
  • Remover uma chave. Abra-a e clique em Remove API Key, depois confirme. Qualquer coisa que ainda use essa chave deixará de funcionar.
  • Pesquisar. Use a caixa de pesquisa acima da lista para encontrar uma chave.

Use Last used para encontrar chaves que ninguém mais precisa. Uma chave que nunca foi usada, ou que não é usada há meses, é uma boa candidata para remoção.

Quem pode fazer isso#

Owner e Admin podem criar, editar e remover chaves. Editor pode ver a lista e criar chaves, mas não pode editá-las nem removê-las. Member, Guest e Maintainer não veem a aba. Consulte equipe e funções.

Seu plano não limita quantas chaves você cria. Espaços de trabalho cancelados não podem criar chaves.

Trate uma chave como uma senha

Qualquer pessoa que tenha a chave pode chamar a API como o seu espaço de trabalho. Se uma chave pode ter vazado, remova-a da lista e crie uma substituta.