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

# Integração com a API do PlayFab

> Encontre e chame APIs do PlayFab no terminal com suas credenciais de desenvolvedor do Microsoft Entra ID em vez de uma chave secreta de título.

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

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

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

Para usar outro título em um único comando, passe `--playfab-title-id`. Consulte
[Contexto](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/context.md).

## 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](https://learn.microsoft.com/rest/api/playfab/) é
  escrita para pessoas.
* As [especificações Swagger do PlayFab](https://github.com/PlayFab/API_Specs/tree/master/Swagger/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`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/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](https://docs.xbox.com/pt-BR/tools/xbox-cli/safety.md).

### Obter os dados 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"
    }
  }
}
```

### Obter uma chave de dados de título

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

### Definir os dados de título

Passe o corpo da solicitação diretamente com `--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": {}
}
```

Ou leia-o de um arquivo com `--body-file`, aqui no PowerShell:

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

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

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

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

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


## Related topics

- [Integração com PlayFab Lobby e Match](https://docs.xbox.com/pt-BR/services/xbox-services/multiplayer/mpa/concepts/live-mpa-playfab-integration.md)
- [Integração com o marketplace - Google](https://docs.xbox.com/pt-BR/services/playfab/economy-monetization/economy-v2/marketplace/marketplace-integrations/google.md)
- [Configurar a autenticação do PlayFab usando Kongregate e Unity](https://docs.xbox.com/pt-BR/services/playfab/identity/player-identity/platform-specific-authentication/kongregate-unity.md)
- [Configurar a autenticação do PlayFab usando Kongregate e HTML5](https://docs.xbox.com/pt-BR/services/playfab/identity/player-identity/platform-specific-authentication/kongregate-html5.md)
- [Integração do PlayFab para títulos dos serviços XBOX](https://docs.xbox.com/pt-BR/services/xbox-services/playfab-integration.md)
