Gerenciando chaves de API

Chaves de API servem como identificadores exclusivos para autenticação, permitindo que usuários, desenvolvedores ou programas acessem um sistema de API com segurança. Chaves de API são frequentemente usadas para rastrear e controlar o uso da API para evitar abusos.

Visão geral de chaves de API

Na seção Chaves de API do Console de gerenciamento, você pode visualizar todas as chaves de API associadas ao seu locatário. É possível pesquisar chaves por nome, ID ou proprietário.

As chaves de API podem ter os seguintes status:

• Ativa: a chave de API está em uso no momento.
• Expirada: a data de validade foi atingida.
• Revogada: a chave API foi revogada e não pode mais ser usada.

Os administradores de locatários podem ativar a geração de chaves de API, bem como monitorar e revogar chaves de API. Para gerar, editar ou excluir chaves de API, é necessário ter a função Desenvolvedor. Administradores de locatários podem atribuir essa função a usuários, inclusive a eles próprios.

Habilitando chaves de API no locatário

Por padrão, chaves de API estão desabilitadas. Administradores de locatários podem ativar chaves de API dentro do locatário.

Faça o seguinte:

1. No Console de gerenciamento, acesse Configurações.
2. Localize a seção Chaves de API e selecione Habilitar chaves de API.
3. Se necessário, ajuste as seguintes configurações:

   • Alterar expiração máxima do token: modifica a expiração de tokens recém-gerados. As chaves de API existentes mantêm seu valor de expiração original. Não há limite máximo para esse valor.

     Nota informativaTalvez seja necessário atualizar o navegador para ver as alterações nesse valor refletidas na seção Chaves de API na página do seu perfil de usuário.
   • Alterar máximo de chaves de API ativas por usuário: essa configuração afeta apenas as novas chaves de API. Se o limite for atingido, a criação de novas chaves de API será negada. O valor máximo é 1000.

4. Para começar a gerar chaves de API, clique em Gerar nova. Isso redirecionará você para a seção Chaves de API na página de perfil do usuário, onde é possível criar novas chaves.

Geração de chaves de API

Você pode gerar chaves de API a partir do hub. Antes de começar, verifique se os requisitos a seguir foram atendidos:

• Você tem uma licença ativa.

• A opção Habilitar chaves de API está ativa no Console de gerenciamento.
• Você tem a função Desenvolvedor.

Faça o seguinte:

1. Clique no ícone do seu perfil de usuário no canto superior direito e selecione Configurações de perfil.

2. Na seção Chaves de API, clique em Gerar nova chave.

3. Forneça uma descrição e um tempo de expiração para a chave de API.

4. Clique em Gerar para criar a chave.

5. Copie imediatamente a chave de API gerada e armazene-a com segurança. A chave não pode ser recuperada posteriormente.

Após a criação, você pode editar o nome da chave de API ou excluí-la, se necessário.

Com sua chave de API, você pode explorar a referência da REST API em qlik.dev usando ferramentas como Postman, ou instalar qlik-cli para acessar os recursos do Qlik diretamente da linha de comando. Para obter mais informações, consulte Visão geral das APIs da Qlik e qlik-cli.

Monitoramento e revogação de chaves de API

Como administrador de locatários, é essencial monitorar as atividades da chave de API para fins de segurança. Se forem detectadas atividades suspeitas, você poderá revogar a chave de API.

Lembre-se de que a revogação de uma chave de API a desativará imediatamente, afetando todos os processos ou integrações em andamento que dependam dela. A revogação é irreversível, e uma chave de API revogada não pode ser reativada.

Faça o seguinte:

1. No Console de gerenciamento, acesse a seção Eventos.

2. Procure atividades suspeitas, como o uso excessivo de uma determinada chave de API.

3. Clique em ao lado do evento para expandir seus detalhes e copiar o ID da chave da API.

4. Acesse a seção Chaves de API e procure a chave de API usando seu ID.

5. Clique em ao lado da chave e selecione Revogar. Você só pode revogar chaves com o status Ativa.

6. Para revogar várias chaves de API, selecione-as na tabela e clique em Revogar no canto superior direito.

Exclusão de chaves de API

A exclusão de chaves de API as remove permanentemente do sistema. A exclusão de uma chave de API é irreversível e removerá imediatamente seus privilégios de acesso. Certifique-se de que essa ação não interromperá nenhum processo ou integração em andamento que dependa da chave.

Você precisa da função de Desenvolvedor para excluir chaves de API.

Faça o seguinte:

1. Clique no ícone do seu perfil de usuário no canto superior direito e selecione Configurações de perfil.

2. Selecione a seção Chaves de API.

3. Clique em ao lado da chave de API que você deseja excluir e selecione Excluir.

4. Se quiser remover todas as chaves, clique em Excluir tudo acima da lista de chaves de API.