Uma Chave Segura é um registro criptografado que guarda uma credencial, como um token de acesso, uma senha ou uma API key. Em vez de inserir a credencial diretamente nos campos de uma integração, você cadastra uma chave e utiliza a referência dela no formato @[chave].
Dessa forma, a credencial não fica exposta nas configurações da integração e pode ser atualizada em um único lugar sempre que necessário.
Toda chave criada recebe automaticamente o prefixo CV-PASS- em seu nome.
Para acessar, siga o caminho: Configurações > Geral > Integrações e clique no botão Gerenciar Chaves.
Ao clicar, a tela de Chaves Seguras é exibida com a lista de chaves cadastradas. Nela é possível visualizar a chave, a descrição e a data de expiração de cada registro, além de buscar, adicionar, editar e excluir chaves.
Como cadastrar uma chave segura
-
Na tela de Chaves Seguras, clique no botão Adicionar Chave.
-
Preencha os campos:
|
Campo |
Descrição |
|---|---|
|
Chave (obrigatório) |
Nome que identifica a chave. O prefixo |
|
Descrição (obrigatório) |
Texto que facilita a identificação do uso da chave. Por exemplo: Token de Acesso à API X. |
|
Valor (obrigatório) |
A credencial que será protegida, como um token, uma senha ou uma API key. |
|
Data de Expiração |
Data em que a credencial expira ou merece atenção. Ao se aproximar dessa data, a plataforma emite um alerta. |
-
Clique em Adicionar Chave para salvar.
Atenção: o valor da chave será criptografado e não poderá ser visualizado após o cadastro. Confira o valor antes de salvar. Caso precise corrigir, será necessário informar um novo valor na edição da chave.
Nota: espaços em branco e quebras de linha no início e no final do valor são removidos automaticamente, evitando erros de autenticação causados por caracteres invisíveis.
Como usar uma chave em uma integração
-
Na tela de Chaves Seguras, localize a chave desejada e clique no ícone de copiar ao lado do nome. A chave é copiada já no formato de referência
@[chave].
-
Cole a referência no campo da integração em que a credencial seria informada, como o cabeçalho
Authorizationou um campo do corpo da requisição.
Ao executar a integração, a plataforma substitui a referência @[chave] pelo valor protegido da chave.
Exemplo: em vez de preencher o cabeçalho com o token em texto aberto, utilize a referência da chave.
|
Campo |
Valor |
|---|---|
|
Authorization |
|
Dica: veja como configurar os campos de autenticação nas páginas [Integração por Token Fixo] e [Integração por JWT].
Data de expiração e alertas
Ao cadastrar uma data de expiração, a plataforma monitora a validade da chave e exibe indicadores na tabela:
|
Indicador |
Significado |
|---|---|
|
🔴 Expirado (vermelho) |
A chave está expirada. Atualize o valor para evitar falhas nas integrações. |
|
🟠 Expira em breve (laranja) |
A chave expira em breve. Programe a atualização da credencial. |
Quando a data é atingida, os administradores da plataforma são alertados.
Como alterar o valor de uma chave
-
Na tela de Chaves Seguras, clique no ícone de editar da chave desejada.
-
Informe o novo valor. Os campos Chave, Descrição e Data de Expiração não podem ser alterados.
-
Clique em Salvar Alterações.
A alteração é aplicada automaticamente em todas as integrações que utilizam a chave, sem necessidade de reconfiguração.
Como excluir uma chave
Na tela de Chaves Seguras, clique no ícone de excluir da chave desejada e confirme a ação.
Atenção: não é possível excluir uma chave que esteja sendo utilizada em uma integração. Nesse caso, a plataforma exibe uma mensagem informando o bloqueio e a lista de integrações que utilizam a chave. Remova a referência
@[chave]dessas integrações antes de excluir o registro.
Alertas de segurança
Para garantir a proteção das credenciais, a plataforma identifica tokens, senhas e API keys informados em texto aberto nos campos das integrações, como nos cabeçalhos Authorization, Api-Key e similares. Quando isso ocorre, os administradores recebem um alerta para que as credenciais sejam substituídas por Chaves Seguras.