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

> Chame qualquer endpoint da API do PlayFab diretamente pelo caminho dele, com um corpo de solicitação JSON.

`playfab api` chama qualquer endpoint da API do PlayFab pelo caminho dele, envia o corpo de solicitação que você passa
e grava a resposta do PlayFab como JSON. Para encontrar uma operação e o corpo de solicitação dela, consulte
[Encontrar uma API](https://docs.xbox.com/pt-BR/tools/xbox-cli/playfab-api.md#finding-an-api).

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

O comando precisa de um título do PlayFab, exceto para as APIs de estúdio (`/Studio/*`), que não têm
escopo de um título. Consulte [Contexto](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/context.md).

O que o comando altera depende do caminho. As operações cujos nomes começam com `Get`,
`List` ou `Search` apenas leem. As operações `Delete*` e `Shutdown*` perguntam primeiro em um
terminal e precisam de `--confirm` (`--yes`, `-y`) nos demais casos. Consulte
[Segurança e operações destrutivas](https://docs.xbox.com/pt-BR/tools/xbox-cli/safety.md).

## Argumentos e opções

| Argumento/opção | Obrigatório | Descrição |
| - | - | - |
| `<api-path>` | Sim | Caminho da API do PlayFab, `/<Prefix>/<Operation>`, como `/Admin/GetTitleData` ou `/Catalog/SearchItems`. Deve começar com `/`. No Git Bash, consulte [Executar no Git Bash no Windows](#running-from-git-bash-on-windows). |
| `--body <body>` | Não | O objeto de solicitação JSON da operação, embutido. O padrão é `{}` quando nem `--body` nem `--body-file` é passado. |
| `--body-file <body-file>` | Não | Caminho para um arquivo que contém o objeto de solicitação JSON, ou `-` para lê-lo de stdin. |
| `--data-only` | Não | Grava somente o campo `data` da resposta do PlayFab. |
| `--output`, `-o` | Não | `json` (padrão) ou `json-compact`. |
| `--verbose` | Não | Grava diagnósticos em stderr, sem o corpo da solicitação. |

`--body` e `--body-file` não podem ser combinadas. A CLI envia o corpo como você o passa,
sem validá-lo.

## Exemplos

```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
```

### Ler o corpo da solicitação de stdin

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

Stdin fornece um corpo de solicitação, lido até o fim da entrada, e não uma solicitação por linha.
Com `--body-file -`, as operações `Delete*` e `Shutdown*` precisam de `--confirm` mesmo em um
terminal, porque stdin não pode responder à solicitação de confirmação.

## Executar no Git Bash no Windows

O Git Bash, assim como outros shells MSYS, converte um argumento que começa com `/` em um caminho do Windows
antes de iniciar um programa do Windows. A CLI recusa o caminho convertido e informa como
corrigi-lo:

```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
```

Defina `MSYS_NO_PATHCONV=1` para um comando:

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

Ou exporte-a para o restante da sessão:

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

Com a conversão desativada, o Git Bash também não converte outros caminhos; portanto, passe para
`--body-file` um caminho relativo ou um caminho do Windows, como `C:/requests/search.json`, e não
`/c/requests/search.json`.

## Saída

A resposta do PlayFab, em seu envelope `{code,status,data}`; consulte
[Envelope de resposta](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/playfab.md#response-envelope). Quando a chamada falha, o comando
grava o erro em stderr e sai com o código `1`; consulte
[Respostas de erro](https://docs.xbox.com/pt-BR/tools/xbox-cli/playfab-api.md#error-responses).

`playfab api` não aceita `--output table`.


## Related topics

- [api_operation](https://docs.xbox.com/pt-BR/services/playfab/api-references/events/Segmentation/api-operation.md)
- [Validate Api Policy](https://docs.xbox.com/api-reference/authentication/validate-api-policy.md)
- [Política de API](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/playfab/api-policy.md)
- [Referência de API (conteúdo)](https://docs.xbox.com/pt-BR/reference/gc-reference-toc.md)
- [Referência da API REST](https://docs.xbox.com/pt-BR/services/playfab/api-references/index.md)
