> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Integración de la API de PlayFab

> Busca y llama a las API de PlayFab desde el terminal con tus credenciales de desarrollador de Microsoft Entra ID en lugar de una clave secreta de título.

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](https://docs.xbox.com/es/tools/xbox-cli/authentication.md#how-playfab-authentication-works).

## 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.

```bash theme={null}
xbox auth login
xbox context set playfab-title-id ABC123
xbox playfab api /Admin/GetTitleData
```

Para usar otro título en un solo comando, pasa `--playfab-title-id`. Consulta
[Contexto](https://docs.xbox.com/es/tools/xbox-cli/commands/context.md).

## 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](https://learn.microsoft.com/rest/api/playfab/) está
  escrita para personas.
* Las [especificaciones Swagger de PlayFab](https://github.com/PlayFab/API_Specs/tree/master/Swagger/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`](https://docs.xbox.com/es/tools/xbox-cli/commands/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](https://docs.xbox.com/es/tools/xbox-cli/safety.md).

### Obtener datos de título

```bash theme={null}
xbox --playfab-title-id ABC123 playfab api /Admin/GetTitleData
```

```json theme={null}
{
  "code": 200,
  "status": "OK",
  "data": {
    "Data": {
      "SettingA": "the value",
      "SettingB": "another value"
    }
  }
}
```

### Obtener una clave de datos de título

```bash theme={null}
xbox --playfab-title-id ABC123 playfab api /Admin/GetTitleData --body '{"Keys":["MyKey"]}'
```

### Establecer datos de título

Pasa el cuerpo de la solicitud insertado con `--body`:

```bash theme={null}
xbox --playfab-title-id ABC123 playfab api /Admin/SetTitleData --body '{ "Key": "MyKey", "Value": "my-value" }'
```

```json theme={null}
{
  "code": 200,
  "status": "OK",
  "data": {}
}
```

O léelo de un archivo con `--body-file`, aquí en PowerShell:

```powershell theme={null}
'{ "Key": "MyKey", "Value": "my-value" }' > data.json
xbox --playfab-title-id ABC123 playfab api /Admin/SetTitleData --body-file data.json
```

### 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:

```bash theme={null}
xbox --playfab-title-id ABC123 --data-only --output json-compact playfab api /Admin/GetTitleData
```

```json theme={null}
{"Data":{"MyKey":"my-value"}}
```

## 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.


## Related topics

- [Notas de la versión de PlayFab de 2015](https://docs.xbox.com/es/announcements/playfab/2015.md)
- [Integración de PlayFab para títulos de los servicios de XBOX](https://docs.xbox.com/es/services/xbox-services/playfab-integration.md)
- [Notas de la versión de PlayFab de 2016](https://docs.xbox.com/es/announcements/playfab/2016.md)
- [Notas de la versión de PlayFab 2015](https://docs.xbox.com/es/services/playfab/release-notes/2015.md)
- [Notas de la versión de PlayFab 2016](https://docs.xbox.com/es/services/playfab/release-notes/2016.md)
