Pular para o conteúdo principal

Sobre as APIs do PlayFab

Os clientes de jogo fazem solicitações às APIs do PlayFab usando URIs como:
  • /client/loginwithxbox
  • /catalog/getitems
  • /cloudscript/executefunction
Essas solicitações incluem um conteúdo de dados que informa ao PlayFab o que fazer: qual jogador conectar, qual item recuperar, qual função executar.

O que é uma política de acesso à API?

Cada título do PlayFab tem uma política de acesso à API: uma lista de instruções de permissão que controlam quais APIs do PlayFab os jogadores podem invocar a partir do cliente do jogo. A política funciona como um firewall no nível do título: quando um cliente faz uma chamada de API, o PlayFab avalia a política para determinar se a solicitação deve ser permitida ou negada. A política de acesso à API padrão permite a maioria das APIs.

Por que modificar a política de acesso à API?

  • Restringir o acesso a recursos que seu título não está usando
  • Impedir que jogadores mal-intencionados aumentem seus custos
  • Proteção contra erros de digitação durante o desenvolvimento

Estrutura

A política de acesso à API de um título é uma lista ordenada de instruções. Cada instrução tem estes campos:

Efeito Deny

O efeito Deny tem precedência sobre o efeito Allow. Se um recurso com curinga (por exemplo, pfrn:api--/CloudScript/*) tiver um efeito Deny, nenhuma API que comece com esse recurso poderá ser acessada, mesmo que tenha efeitos Allow específicos.

Página API Access Policy

A página API Access Policy na página de configurações do seu título no Game Manager fornece uma interface para exibir e editar a política de acesso à API do título.

Página de índice

A página de índice exibe uma tabela de todas as categorias de API com as seguintes colunas:

Ações disponíveis

  • Search: filtre a lista de categorias por nome ou por caminho de API. Esse filtro é mantido na página da categoria.
  • Edit as JSON: abre um editor JSON da política completa para usuários avançados. Salvar aqui substitui a política inteira de uma vez e entra em vigor imediatamente.
  • Revert to Defaults: redefine toda a política para a política padrão do PlayFab e salva imediatamente. Uma caixa de diálogo de confirmação é exibida antes que essa ação seja executada.

Página da categoria

Clicar no nome de uma categoria leva à página de detalhes, que lista todas as APIs dessa categoria com controles individuais. Todas as alterações nas caixas de seleção desta página precisam ser salvas antes de entrar em vigor.

Regra curinga

Na parte superior de cada grupo de padrões de recurso há uma regra curinga, um grupo de botões de opção para Allow ou Deny. Ela define o efeito padrão para todas as APIs desse grupo. Quando o curinga é definido como Deny, todas as alternâncias de API individuais abaixo dele ficam desabilitadas, pois a categoria inteira está bloqueada.

Alternâncias por API

Abaixo da regra curinga, cada ponto de extremidade de API é listado com uma caixa de seleção. Quando marcada, a API é permitida; quando desmarcada, é negada. Essas alternâncias por API permitem criar exceções à regra curinga. Por exemplo, negue todas as Client APIs por padrão e, em seguida, permita explicitamente apenas as que seu título usa.

Ações disponíveis

  • Save: salva somente as instruções da categoria atual
  • Reset: descarta todas as alterações não salvas desta categoria
  • Edit as JSON: abre um editor JSON com escopo das instruções desta categoria
  • Search: filtra a lista de APIs dentro da categoria

Barra lateral de resumo de alterações

As duas páginas incluem uma barra lateral Pending changes no lado direito da tela. Essa barra lateral mostra uma lista em tempo real de todas as instruções que você alterou desde o último salvamento, com rótulos codificados por cores:
  • Allow: um recurso foi alterado para permitir
  • Deny: um recurso foi alterado para negar
  • Removed: uma instrução anteriormente explícita foi removida (a API herda a regra curinga da categoria)
Na página de índice, cada alteração na barra lateral tem um link para a página da categoria relevante.
Última modificação em 8 de outubro de 2026