Saltar al contenido principal
La XBOX CLI puede llamar a cualquier API de PlayFab que acepte una clave secreta de título o un token de entidad de título, usando en su lugar tus credenciales de desarrollador de Microsoft Entra ID. Las API que solo aceptan tokens de entidad de jugador o de servidor de juegos no están autorizadas de esta forma. Necesitas el permiso Admin en el título de PlayFab. Consulta Cómo funciona la autenticación de PlayFab.

Configuración

Inicia sesión, guarda el id. de título de PlayFab como predeterminado y realiza una solicitud de solo lectura. Reemplaza ABC123 por tu id. de título.
Para usar otro título en un solo comando, pasa --playfab-title-id. Consulta Contexto.

Buscar una API

PlayFab documenta todas las operaciones, sus esquemas de solicitud y respuesta, qué campos son obligatorios y qué credenciales aceptan:
  • La referencia de la API REST de PlayFab está escrita para personas.
  • Las especificaciones Swagger de PlayFab son legibles por máquina. Los archivos llevan el nombre de los grupos de API de PlayFab, no del primer segmento de la ruta, así que busca la operación en las paths de los archivos. Por ejemplo, /Catalog e /Inventory están en Economy.swagger.json, y /Match, /Lobby y /MultiplayerServer están en Multiplayer.swagger.json.
  • El campo security de cada operación indica la credencial que acepta: SecretKey (una clave secreta de título), EntityToken, SessionTicket (una sesión de jugador) o None. Algunas operaciones también enumeran en su descripción los tipos de token de entidad permitidos.
La ruta de la API es /<Prefix>/<Operation>, como /Admin/GetTitleData, y el cuerpo de la solicitud es el objeto de solicitud JSON de la operación.

Ejemplos

Estos ejemplos llaman a la API con playfab api, que tiene la referencia completa de opciones. Las operaciones Delete* y Shutdown* preguntan primero en un terminal, y necesitan --confirm en otros entornos; consulta Seguridad y operaciones destructivas.

Obtener datos de título

Obtener una clave de datos de título

Establecer datos de título

Pasa el cuerpo de la solicitud insertado con --body:
O léelo de un archivo con --body-file, aquí en PowerShell:

Obtener solo los datos, en una línea

--data-only quita el sobre de respuesta, y --output json-compact escribe JSON en una sola línea para canalizarlo:

Respuestas de error

Una llamada con errores sale con el código 1:
  • Cuando PlayFab devuelve un error, el comando escribe el JSON de error de PlayFab en stderr, con el formato de --output.
  • Otros errores, como los errores de red, escriben un mensaje de texto sin formato en stderr.
  • Con --data-only, stdout está vacío cuando hay un error.
Última modificación el 19 de noviembre de 2026