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

# API

> Llama directamente a cualquier punto de conexión de la API de PlayFab por su ruta, con un cuerpo de solicitud JSON.

`playfab api` llama a cualquier punto de conexión de la API de PlayFab por su ruta, envía el cuerpo de solicitud que pasas
y escribe la respuesta de PlayFab como JSON. Para buscar una operación y su cuerpo de solicitud, consulta
[Buscar una API](https://docs.xbox.com/es/tools/xbox-cli/playfab-api.md#finding-an-api).

```text theme={null}
xbox playfab api <api-path> [flags]
```

El comando necesita un título de PlayFab, excepto para las API de estudio (`/Studio/*`), que no tienen
como ámbito un título. Consulta [Contexto](https://docs.xbox.com/es/tools/xbox-cli/commands/context.md).

Lo que cambia el comando depende de la ruta. Las operaciones cuyos nombres empiezan por `Get`,
`List` o `Search` solo leen. Las operaciones `Delete*` y `Shutdown*` preguntan primero en un
terminal y, en otros casos, necesitan `--confirm` (`--yes`, `-y`). Consulta
[Seguridad y operaciones destructivas](https://docs.xbox.com/es/tools/xbox-cli/safety.md).

## Argumentos y opciones

| Argumento u opción | Obligatorio | Descripción |
| - | - | - |
| `<api-path>` | Sí | Ruta de la API de PlayFab, `/<Prefix>/<Operation>`, como `/Admin/GetTitleData` o `/Catalog/SearchItems`. Debe empezar por `/`. En Git Bash, consulta [Ejecución desde Git Bash en Windows](#running-from-git-bash-on-windows). |
| `--body <body>` | No | El objeto de solicitud JSON de la operación, insertado. El valor predeterminado es `{}` cuando no se pasa `--body` ni `--body-file`. |
| `--body-file <body-file>` | No | Ruta de acceso a un archivo que contiene el objeto de solicitud JSON, o `-` para leerlo de stdin. |
| `--data-only` | No | Escribe solo el campo `data` de la respuesta de PlayFab. |
| `--output`, `-o` | No | `json` (predeterminado) o `json-compact`. |
| `--verbose` | No | Escribe diagnósticos en stderr, sin el cuerpo de la solicitud. |

`--body` y `--body-file` no se pueden combinar. La CLI envía el cuerpo tal como lo pasas,
sin validarlo.

## Ejemplos

```bash theme={null}
xbox --playfab-title-id ABC123 playfab api /Catalog/GetCatalogConfig
xbox --playfab-title-id ABC123 playfab api /Match/ListMatchmakingQueues --data-only --output json-compact
xbox --playfab-title-id ABC123 playfab api /Catalog/SearchItems --body-file search.json
xbox --playfab-title-id ABC123 playfab api /Admin/GetTitleData --body '{"Keys":["MyKey"]}' --data-only --output json-compact
```

### Leer el cuerpo de la solicitud de stdin

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

Stdin proporciona un cuerpo de solicitud, leído hasta el final de la entrada, no una solicitud por línea.
Con `--body-file -`, las operaciones `Delete*` y `Shutdown*` necesitan `--confirm` incluso en un
terminal, porque stdin no puede responder a la solicitud de confirmación.

## Ejecución desde Git Bash en Windows

Git Bash, al igual que otros shells de MSYS, convierte un argumento que empieza por `/` en una ruta de
Windows antes de iniciar un programa de Windows. La CLI rechaza la ruta convertida e indica cómo
corregirla:

```console theme={null}
$ xbox playfab api /Catalog/GetCatalogConfig
The API path must start with '/', such as /Admin/GetTitleData; got 'C:/Program Files/Git/Catalog/GetCatalogConfig'.
That looks like /Catalog/GetCatalogConfig after Git Bash converted it to a Windows path. Turn the conversion off for the command, for example:
  MSYS_NO_PATHCONV=1 xbox playfab api /Catalog/GetCatalogConfig
```

Establece `MSYS_NO_PATHCONV=1` para un comando:

```bash theme={null}
MSYS_NO_PATHCONV=1 xbox --playfab-title-id ABC123 playfab api /Catalog/GetCatalogConfig
```

O expórtala para el resto de la sesión:

```bash theme={null}
export MSYS_NO_PATHCONV=1
```

Con la conversión desactivada, Git Bash tampoco convierte otras rutas, así que pasa a
`--body-file` una ruta relativa o una ruta de Windows, como `C:/requests/search.json`, no
`/c/requests/search.json`.

## Salida

La respuesta de PlayFab, en su sobre `{code,status,data}`; consulta
[Sobre de respuesta](https://docs.xbox.com/es/tools/xbox-cli/commands/playfab.md#response-envelope). Cuando la llamada falla, el comando
escribe el error en stderr y sale con el código `1`; consulta
[Respuestas de error](https://docs.xbox.com/es/tools/xbox-cli/playfab-api.md#error-responses).

`playfab api` no acepta `--output table`.


## Related topics

- [api_operation](https://docs.xbox.com/es/services/playfab/api-references/events/Segmentation/api-operation.md)
- [Validate Api Policy](https://docs.xbox.com/api-reference/authentication/validate-api-policy.md)
- [Directiva de API](https://docs.xbox.com/es/tools/xbox-cli/commands/playfab/api-policy.md)
- [API de experimentación](https://docs.xbox.com/es/services/playfab/live-service-management/game-configuration/experiments/experimentation-apis.md)
- [Referencia de API (contenido)](https://docs.xbox.com/es/reference/gc-reference-toc.md)
