Gerenciando chaves de API

Chaves de API são identificadores exclusivos usados para autenticação, permitindo que usuários, desenvolvedores ou programas acessem APIs com segurança. Elas são essenciais para rastrear e controlar o uso da API, ajudando a prevenir abusos e garantir uma comunicação segura.

video thumbnail

Usando chaves de API para se conectar às APIs do Qlik Cloud

Você pode usar chaves de API para interagir com a referência da API REST do Qlik. Ferramentas como Postman ou qlik-cli podem ser usadas para acesso à API. Para obter mais informações, consulte Visão geral das APIs da Qlik e qlik-cli.

Exemplo: usando o Postman para se conectar às APIs Qlik

Faça o seguinte:

Inicie o Postman.
Defina o método HTTP como GET.
Insira a URL do endpoint da API do Qlik Cloud.

Por exemplo, para listar todos os espaços no locatário:

https://your-tenant.eu.qlikcloud.com/api/v1/spaces
Na guia Autenticação, escolha Token do Portador como o Tipo de Autenticação.
Insira sua chave de API no campo Token.
Clique em Enviar.

Se a solicitação for bem-sucedida, a API retornará uma resposta JSON. Nesse exemplo, a resposta incluiria uma lista de espaços.

Habilitando chaves de API no locatário

Essa configuração está obsoleta e será removida em uma versão futura. Após a remoção, a criação da chave de API será controlada exclusivamente pela permissão Gerenciar chaves de API.

Os administradores de locatários podem controlar se os usuários têm permissão para gerar chaves de API no locatário.

Faça o seguinte:

No centro de atividades de Administração, acesse a página Configurações.
Selecione a guia Controle de recursos.
Na seção Chaves de API, ative ou desative Ativar chaves de API.

Definindo configurações de chaves do API

Faça o seguinte:

No centro de atividades de Administração, acesse a página Configurações.
Selecione a guia Controle de recursos.
Na seção Chaves de API, ajuste as seguintes configurações conforme necessário:
- Alterar expiração máxima do token: defina o período de expiração para tokens de API recém-gerados. As chaves de API existentes manterão seu valor de expiração original. Não há limite superior para esse valor.
- Alterar máximo de chaves de API ativas por usuário: defina o limite de quantas chaves de API um usuário pode ter. Esse limite se aplica somente a novas chaves. Se o limite for atingido, os usuários não poderão criar chaves adicionais. O valor máximo é 1000.

Talvez seja necessário atualizar seu navegador para ver as alterações refletidas na seção Chaves de API da sua página de configurações pessoais.

Gerando e gerenciando chaves de API

Gerando chaves de API

Para gerar novas chaves de API, você deve ter uma função personalizada com a permissão Gerenciar chaves de API ou a permissão deve estar ativada nas configurações Padrão do usuário.

Faça o seguinte:

Clique no ícone do seu perfil de usuário e selecione Configurações.
Vá para a seção Chaves de API, clique em Gerar nova chave.
Forneça uma descrição e defina um tempo de expiração para a chave de API.
Clique em Gerar para criar a chave.
Copie a chave de API gerada e armazene-a com segurança. Observe que a chave não pode ser recuperada posteriormente.

Editando chaves de API

Você pode alterar o nome de uma chave de API após a criação.

Exclusão de chaves de API

A exclusão de chaves de API é permanente e não pode ser desfeita. Certifique-se de que essa ação não interromperá nenhum processo ou integração em andamento que dependa da chave.

Faça o seguinte:

Clique no ícone do seu perfil de usuário e selecione Configurações.
Vá para a seção Chaves de API.
Clique em ao lado da chave de API que você deseja excluir e selecione Excluir.
Para remover todas as chaves, clique em Excluir tudo acima da lista de chaves.

Monitoramento e revogação de chaves de API

Você pode visualizar todas as chaves de API associadas ao seu locatário na seção Chaves de API do centro de atividades de Administração. É possível pesquisar chaves por nome, ID ou proprietário.

Status das chaves de API

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 de API foi revogada e não pode mais ser usada.

Revogando chaves de API

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

Revogar uma chave de API a desativa imediatamente, afetando quaisquer processos ou integrações em andamento que dependam dela. A revogação é irreversível; uma chave de API revogada não pode ser reativada.

Faça o seguinte:

No centro de atividades de Administração, vá para Eventos.
Procure atividades suspeitas, como o uso excessivo de uma determinada chave de API.
Clique em ao lado do evento para expandir seus detalhes e copiar o ID da chave da API.
Acesse a seção Chaves de API e procure a chave de API usando seu ID.
Clique em ao lado da chave e selecione Revogar. Você só pode revogar chaves com o status Ativa.
Para revogar várias chaves de API, selecione-as na tabela e clique em Revogar no canto superior direito.

Práticas recomendadas para o gerenciamento de chaves de API

Mantenha as chaves confidenciais: armazene chaves de API com segurança e evite expô-las em repositórios de código público.
Regenerar regularmente: regenere periodicamente suas chaves de API para aumentar a segurança.
Monitorar o uso: verifique regularmente as atividades das chaves de API para identificar qualquer comportamento suspeito.

Esta página ajudou?

Se você encontrar algum problema com esta página ou seu conteúdo – um erro de digitação, uma etapa ausente ou um erro técnico – avise-nos!

Deixe seu feedback aqui