A sua chave de API PushEngage autentica pedidos de API para um site, pelo que tudo o que chama a API PushEngage a utiliza. Pode ver, copiar e regenerar a chave a partir das definições do seu site, e cada site tem a sua própria chave. Este guia mostra como encontrar a sua chave de API e como a rotacionar em segurança.
Antes de Começar
- Precisa de estar com sessão iniciada no painel PushEngage com acesso ao site que pretende gerir.
- Regenerar a chave substitui imediatamente a antiga. Qualquer integração que ainda utilize a chave antiga deixa de funcionar até que a atualize com a nova chave, pelo que planeie atualizar as suas integrações logo após a rotação.
- A chave de API é específica para um site. Se gere mais de um site, mude primeiro para o site correto.
Onde Encontrar a Sua Chave de API
No painel PushEngage, vá a Definições do Site » Detalhes do Site e percorra até à secção Chave de API.
Gerar a Sua Primeira Chave de API
Se o site ainda não tiver 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 a Sua Chave de API
Uma vez que uma chave exista, é apresentada mascarada por segurança. Clique em Copiar para copiar a chave completa para a sua área de transferência, depois cole-a onde quer que seja necessária. A chave é sempre apresentada mascarada no ecrã, pelo que utilize Copiar em vez de tentar lê-la.
Rotacionar (Regenerar) a Sua Chave de API
Rotacionar a chave substitui-a por uma nova, o que é a medida correta se a chave puder ter sido exposta, ou como higiene periódica.
- Na secçã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 foi gerada.
- Copie a nova chave e atualize todas as integrações que usavam a antiga.
Perguntas Frequentes
Regenerar a chave vai quebrar as minhas integrações?
Sim, até que as atualize. A chave antiga deixa de funcionar no momento em que a regenera, pelo que qualquer aplicação, plugin ou script que a utilize falhará até que a substitua pela nova chave. Rotacione num momento em que possa atualizar as suas integrações imediatamente.
A chave de API é a mesma em todos os meus sites?
Não. Cada site tem a sua própria chave de API. Se gere vários sites, certifique-se de que está no site correto antes de copiar ou regenerar uma chave.
Porque é que só consigo ver uma chave mascarada?
A chave é apresentada mascarada no ecrã por motivos de segurança. Utilize o botão Copiar para copiar a chave completa para a sua área de transferência.
Quando devo rotacionar a minha chave de API?
Gire-a se achar que a chave foi exposta, quando alguém com acesso a ela sair, ou num cronograma regular como boa prática de segurança. Lembre-se de atualizar as suas integrações com a nova chave cada vez.
Se encontrar algum problema, n0o hesite em contactar-nos clicando aqui. A nossa equipa de suporte poder0 ajud0-lo.