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

# Intégration de l'API PlayFab

> Trouvez et appelez les API PlayFab à partir du terminal avec vos informations d'identification de développeur Microsoft Entra ID au lieu d'une clé secrète de titre.

L'XBOX CLI peut appeler n'importe quelle API PlayFab qui accepte une clé secrète de titre ou un jeton
d'entité de titre, en utilisant plutôt vos informations d'identification de développeur Microsoft Entra ID. Les API qui acceptent
uniquement des jetons d'entité de joueur ou de serveur de jeu ne sont pas autorisées de cette façon.

Vous avez besoin de l'autorisation **Admin** sur le titre PlayFab. Consultez
[Fonctionnement de l'authentification PlayFab](https://docs.xbox.com/fr-CA/tools/xbox-cli/authentication.md#how-playfab-authentication-works).

## Configuration

Connectez-vous, enregistrez votre ID de titre PlayFab comme valeur par défaut et effectuez une requête en lecture seule.
Remplacez `ABC123` par votre ID de titre.

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

Pour utiliser un autre titre pour une seule commande, passez `--playfab-title-id`. Consultez
[Contexte](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands/context.md).

## Trouver une API

PlayFab documente chaque opération, ses schémas de requête et de réponse, les champs
obligatoires et les informations d'identification qu'elle accepte :

* La [référence de l'API REST PlayFab](https://learn.microsoft.com/rest/api/playfab/) est
  rédigée à l'intention des personnes.
* Les [spécifications Swagger de PlayFab](https://github.com/PlayFab/API_Specs/tree/master/Swagger/PlayFab)
  sont lisibles par machine. Les fichiers sont nommés d'après les groupes d'API de PlayFab, et non d'après le premier
  segment du chemin; cherchez donc l'opération dans les `paths` des fichiers. Par exemple, `/Catalog`
  et `/Inventory` se trouvent dans `Economy.swagger.json`, et `/Match`, `/Lobby` et
  `/MultiplayerServer` se trouvent dans `Multiplayer.swagger.json`.
* Le champ `security` de chaque opération nomme les informations d'identification qu'elle accepte : `SecretKey` (une clé
  secrète de titre), `EntityToken`, `SessionTicket` (une session de joueur) ou `None`. Certaines
  opérations indiquent également dans leur description les types de jetons d'entité qu'elles autorisent.

Le chemin de l'API est `/<Prefix>/<Operation>`, comme `/Admin/GetTitleData`, et le corps de la
requête est l'objet de requête JSON de l'opération.

## Exemples

Ces exemples appellent l'API avec [`playfab api`](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands/playfab/api), dont la page contient la
référence complète des options. Les opérations `Delete*` et `Shutdown*` demandent d'abord une confirmation dans un terminal et nécessitent
`--confirm` ailleurs; consultez [Sécurité et opérations destructrices](https://docs.xbox.com/fr-CA/tools/xbox-cli/safety.md).

### Obtenir les données de titre

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

### Obtenir une seule clé de données de titre

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

### Définir des données de titre

Passez le corps de la requête directement avec `--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": {}
}
```

Vous pouvez aussi le lire à partir d'un fichier avec `--body-file`, ici dans PowerShell :

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

### Obtenir uniquement les données, sur une seule ligne

`--data-only` supprime l'enveloppe de réponse, et `--output json-compact` écrit du JSON sur une seule
ligne pour la redirection :

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

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

## Réponses d'erreur

Un appel qui échoue se termine avec le code `1` :

* Lorsque PlayFab renvoie une erreur, la commande écrit le JSON d'erreur de PlayFab sur stderr,
  mis en forme selon `--output`.
* Les autres échecs, comme les erreurs réseau, écrivent un message en texte brut sur stderr.
* Avec `--data-only`, stdout est vide en cas d'erreur.


## Related topics

- [Notes de publication PlayFab 2015](https://docs.xbox.com/fr-CA/services/playfab/release-notes/2015.md)
- [Notes de version de PlayFab 2015](https://docs.xbox.com/fr-CA/announcements/playfab/2015.md)
- [Notes de publication PlayFab 2016](https://docs.xbox.com/fr-CA/services/playfab/release-notes/2016.md)
- [Notes de version de PlayFab 2016](https://docs.xbox.com/fr-CA/announcements/playfab/2016.md)
- [API Experimentation de PlayFab](https://docs.xbox.com/fr-CA/services/playfab/api-references/rest/experimentation/overview.md)
