Sua chave de API do PushEngage autentica requisições de API para um site, então tudo que chama a API do PushEngage a utiliza. Você pode visualizar, copiar e regenerar a chave nas configurações do seu site, e cada site tem sua própria chave. Este guia mostra como encontrar sua chave de API e como rotacioná-la com segurança.
Antes de Começar
- Você precisa estar conectado ao painel do PushEngage com acesso ao site que deseja gerenciar.
- Regenerar a chave substitui imediatamente a antiga. Qualquer integração que ainda use a chave antiga para de funcionar até que você a atualize com a nova chave, então planeje atualizar suas integrações logo após a rotação.
- A chave de API é específica para um site. Se você gerencia mais de um site, mude para o site correto primeiro.
Onde Encontrar Sua Chave de API
No painel do PushEngage, vá para Configurações do Site » Detalhes do Site e role até a seção Chave de API.
Gerar Sua Primeira Chave de API
Se o site ainda não tem uma chave de API, clique em Gerar uma nova Chave de API. O PushEngage cria a chave e confirma com “Chave de API gerada com sucesso.”
Copiar Sua Chave de API
Uma vez que uma chave existe, ela é exibida mascarada por segurança. Clique em Copiar para copiar a chave completa para a sua área de transferência, depois cole-a onde for necessário. A chave só é exibida mascarada na tela, então use Copiar em vez de tentar lê-la.
Rotacionar (Regenerar) Sua Chave de API
Rotacionar a chave a substitui por uma nova, o que é a atitude correta se a chave pode ter sido exposta, ou como higiene periódica.
- Na seção Chave de API, clique em Regenerar Chave de API.
- No prompt de confirmação, “Deseja regenerar a chave de API?”, clique em Sim, Regenerar.
- O PushEngage emite uma nova chave e confirma que ela foi gerada.
- Copie a nova chave e atualize todas as integrações que usavam a antiga.
Perguntas Frequentes
Regenerar a chave quebrará minhas integrações?
Sim, até que você as atualize. A chave antiga para de funcionar no momento em que você a regenera, então qualquer aplicativo, plugin ou script que a utilize falhará até que você a substitua pela nova chave. Rotacione em um momento em que você possa atualizar suas integrações imediatamente.
A chave de API é a mesma em todos os meus sites?
Não. Cada site tem sua própria chave de API. Se você gerencia vários sites, certifique-se de estar no site correto antes de copiar ou regenerar uma chave.
Por que só consigo ver uma chave mascarada?
A chave é exibida mascarada na tela por segurança. Use o botão Copiar para copiar a chave completa para a sua área de transferência.
Quando devo rotacionar minha chave de API?
Gire-a se você acha que a chave foi exposta, quando alguém com acesso a ela sair, ou em um cronograma regular como uma boa prática de segurança. Lembre-se de atualizar suas integrações com a nova chave a cada vez.
Se você encontrar algum problema, sinta-se à vontade para entrar em contato conosco clicando aqui. Nossa equipe de suporte poderá ajudá-lo.