Pular para o conteúdo principal
A XBOX CLI pode chamar qualquer API do PlayFab que aceite uma chave secreta de título ou um token de entidade de título, usando suas credenciais de desenvolvedor do Microsoft Entra ID. As APIs que aceitam somente tokens de entidade de jogador ou de servidor de jogo não são autorizadas dessa forma. Você precisa da permissão Admin no título do PlayFab. Consulte Como a autenticação do PlayFab funciona.

Configuração

Entre, salve a ID do seu título do PlayFab como padrão e faça uma solicitação somente leitura. Substitua ABC123 pela ID do seu título.
Para usar outro título em um único comando, passe --playfab-title-id. Consulte Contexto.

Encontrar uma API

O PlayFab documenta todas as operações, os esquemas de solicitação e de resposta delas, quais campos são obrigatórios e quais credenciais elas aceitam:
  • A referência da API REST do PlayFab é escrita para pessoas.
  • As especificações Swagger do PlayFab são legíveis por máquina. Os arquivos têm os nomes dos grupos de API do PlayFab, não do primeiro segmento do caminho; portanto, pesquise a operação nos paths dos arquivos. Por exemplo, /Catalog e /Inventory estão em Economy.swagger.json, e /Match, /Lobby e /MultiplayerServer estão em Multiplayer.swagger.json.
  • O campo security de cada operação nomeia a credencial que ela aceita: SecretKey (uma chave secreta de título), EntityToken, SessionTicket (uma sessão de jogador) ou None. Algumas operações também listam os tipos de token de entidade permitidos na descrição.
O caminho da API é /<Prefix>/<Operation>, como /Admin/GetTitleData, e o corpo da solicitação é o objeto de solicitação JSON da operação.

Exemplos

Estes exemplos chamam a API com playfab api, que tem a referência completa de opções. As operações Delete* e Shutdown* perguntam primeiro em um terminal e precisam de --confirm nos demais casos; consulte Segurança e operações destrutivas.

Obter os dados de título

Obter uma chave de dados de título

Definir os dados de título

Passe o corpo da solicitação diretamente com --body:
Ou leia-o de um arquivo com --body-file, aqui no PowerShell:

Obter somente os dados, em uma linha

--data-only descarta o envelope de resposta, e --output json-compact grava JSON em uma única linha para redirecionamento:

Respostas de erro

Uma chamada com falha sai com o código 1:
  • Quando o PlayFab retorna um erro, o comando grava o JSON de erro do PlayFab em stderr, formatado de acordo com --output.
  • Outras falhas, como erros de rede, gravam uma mensagem de texto simples em stderr.
  • Com --data-only, stdout fica vazio em caso de erro.
Última modificação em 19 de novembro de 2026