Pular para o conteúdo principal
Primeiros passos

Esta página ainda não foi traduzida: mostrando a versão em inglês.

Gerenciamento de API keys

Uma API key identifica o seu Project e o Environment para o PlayServ. O cliente do jogo, os seus servidores, o CLI e a CI se autenticam com uma. As keys ficam na página Projects: selecione o cartão de um Project e as keys dele aparecem no painel API keys, abaixo dos cartões, para o Environment escolhido na barra superior.


Tipos de key

TipoPrefixoOnde usarO que pode
Serversk_O seu backend, Game servers, CI e o CLITudo o que o runtime do Project permite, inclusive fazer login no CLI. Mantenha em segredo.
Clientpk_A build do jogo que você distribui aos PlayersO que um cliente de jogo precisa: fazer o login de Players, ler dados dentro das regras de acesso de cada tabela, chamar Functions e receber Events. Pode ser distribuída com segurança.

Nunca inclua uma server key em uma build do jogo

Quem extrair uma server key da sua build ganha acesso total ao runtime do Project. Os Players recebem apenas client keys.

Cada key pertence a um Environment. Uma key de dev não funciona em prod, e o painel mostra só as keys do Environment selecionado na barra superior.

Para ver ou criar keys de outro Environment, troque primeiro o Environment na barra superior. Dar a cada consumidor a própria key — uma por desenvolvedor, uma para a CI, uma por servidor — garante que revogar uma nunca derrube as outras.


Criar uma key

Abra Create key

Em Projects, selecione o Project e clique em Create key no painel API keys.

Dê um nome e escolha o tipo

Informe um Name que diga onde a key é usada, por exemplo prod-server-ci, escolha Server ou Client e clique em Create key.

O diálogo mostra o Environment a que a key vai pertencer: o que está selecionado na barra superior. Ele não pode ser alterado aqui; para criar uma key em outro Environment, feche o diálogo e troque o Environment antes.

Guarde o segredo

O segredo completo aparece em Save your token. Um segredo tem a forma sk_dev_ ou pk_dev_ seguida de 32 caracteres.

Guarde o segredo antes de fechar o diálogo

O segredo é mostrado uma única vez. Copie-o para um gerenciador de senhas ou para os segredos da sua CI antes de clicar em I've saved it, close: o PlayServ não consegue mostrá-lo de novo. Se você o perder, rotacione a key para obter um novo.


A lista de keys

ColunaO que mostra
NamePasse o mouse para ver quem criou a key e quando. Clique para renomear.
Type · EnvServer ou client, e o Environment.
PrefixO início e o fim do segredo, mascarados.
Key IDO id permanente da key, com um botão de copiar. Ele não muda quando você rotaciona o segredo.
StatusQuando a key foi usada pela última vez, ou never. Fica âmbar quando a key não é usada há 30 dias.

Filtre por Server ou Client e ordene por Last used, Created ou Name. A faixa acima da lista conta as keys ativas e as que não são usadas há 30 dias; clique nessa contagem para levar as keys paradas para o topo.


Rotacionar um segredo

Rotate secret, no menu de uma key, substitui o segredo dela e mostra o novo uma única vez, em Save your new token. A key mantém o nome, o tipo e o id.

O segredo antigo para de funcionar na hora

A rotação é uma troca imediata: tudo o que ainda usa o segredo antigo passa a ser recusado a partir desse momento. Atualize antes os seus servidores e a CI, ou esteja pronto para atualizá-los na sequência. Conexões que já estão abertas continuam abertas.

Rotacione uma server key quando ela possa ter vazado, ou de forma periódica.

Rotacionar uma client key derruba as builds já distribuídas

O jogo usa a client key toda vez que renova a sessão de um Player, mais ou menos a cada 15 minutos. Depois de uma rotação, toda build com a key antiga perde a sessão e não consegue fazer o login de Players até que eles instalem uma build com a key nova. Uma build com key nova também não encontra o Player anônimo salvo no aparelho e começa um novo. Rotacione uma client key só se ela tiver vazado.


Revogar uma key

Revoke, no menu de uma key, impede imediatamente que ela se autentique e fecha todas as conexões ao vivo que a usam.

QuandoO que acontece
UndoPor 60 segundos, a linha mostra Undo com uma contagem regressiva, e a notificação também. Desfazer restaura a key, mas as conexões que foram fechadas continuam fechadas.
Depois de 60 segundosA key vai para o grupo recolhido Revoked, onde dá para ver quando e por quem ela foi revogada. Ela não pode ser recuperada.

Uma key em processo de revogação não pode ser rotacionada até você desfazer a revogação. Revogue uma key quando um consumidor inteiro deve perder o acesso; rotacione quando só o segredo estiver comprometido.


Próximos passos

Atualizado em 15 de out. de 2026