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

> Appelez directement n'importe quel point de terminaison de l'API PlayFab par son chemin, avec un corps de requête JSON.

`playfab api` appelle n'importe quel point de terminaison de l'API PlayFab par son chemin, envoie le corps de requête que vous transmettez,
et écrit la réponse de PlayFab en JSON. Pour trouver une opération et son corps de requête, consultez
[Trouver une API](https://docs.xbox.com/fr-CA/tools/xbox-cli/playfab-api.md#finding-an-api).

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

La commande a besoin d'un titre PlayFab, sauf pour les API de studio (`/Studio/*`), qui ne sont pas
limitées à un titre. Consultez [Contexte](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands/context.md).

Ce que la commande modifie dépend du chemin. Les opérations dont le nom commence par `Get`,
`List` ou `Search` effectuent seulement des lectures. Les opérations `Delete*` et `Shutdown*` demandent d'abord une confirmation dans un
terminal, et ont besoin de `--confirm` (`--yes`, `-y`) ailleurs. Consultez
[Sécurité et opérations destructrices](https://docs.xbox.com/fr-CA/tools/xbox-cli/safety.md).

## Arguments et options

| Argument / option | Obligatoire | Description |
| - | - | - |
| `<api-path>` | Oui | Chemin de l'API PlayFab, `/<Prefix>/<Operation>`, comme `/Admin/GetTitleData` ou `/Catalog/SearchItems`. Il doit commencer par `/`. Dans Git Bash, consultez [Exécuter à partir de Git Bash sous Windows](#running-from-git-bash-on-windows). |
| `--body <body>` | Non | L'objet de requête JSON de l'opération, en ligne. Par défaut, `{}` lorsque ni `--body` ni `--body-file` n'est transmise. |
| `--body-file <body-file>` | Non | Chemin d'un fichier contenant l'objet de requête JSON, ou `-` pour le lire à partir de stdin. |
| `--data-only` | Non | Écrire uniquement le champ `data` de la réponse PlayFab. |
| `--output`, `-o` | Non | `json` (par défaut) ou `json-compact`. |
| `--verbose` | Non | Écrire les diagnostics sur stderr, sans le corps de la requête. |

`--body` et `--body-file` ne peuvent pas être combinées. La CLI envoie le corps tel que vous le transmettez,
sans le valider.

## Exemples

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

### Lire le corps de la requête à partir de stdin

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

Stdin fournit un seul corps de requête, lu jusqu'à la fin de l'entrée, et non une requête par ligne.
Avec `--body-file -`, les opérations `Delete*` et `Shutdown*` ont besoin de `--confirm` même dans un
terminal, car stdin ne peut pas répondre à l'invite.

## Exécuter à partir de Git Bash sous Windows

Git Bash, comme les autres interpréteurs de commandes MSYS, convertit un argument qui commence par `/` en chemin
Windows avant de lancer un programme Windows. La CLI refuse le chemin converti et indique comment
corriger le problème :

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

Définissez `MSYS_NO_PATHCONV=1` pour une seule commande :

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

Ou exportez-la pour le reste de la session :

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

Lorsque la conversion est désactivée, Git Bash ne convertit pas non plus les autres chemins; transmettez donc à
`--body-file` un chemin relatif ou un chemin Windows, comme `C:/requests/search.json`, et non
`/c/requests/search.json`.

## Sortie

La réponse de PlayFab, dans son enveloppe `{code,status,data}`; consultez
[Enveloppe de réponse](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands/playfab.md#response-envelope). Lorsque l'appel échoue, la commande
écrit l'erreur sur stderr et se termine avec le code `1`; consultez
[Réponses d'erreur](https://docs.xbox.com/fr-CA/tools/xbox-cli/playfab-api.md#error-responses).

`playfab api` n'accepte pas `--output table`.


## Related topics

- [api_operation](https://docs.xbox.com/fr-CA/services/playfab/api-references/events/Segmentation/api-operation.md)
- [API EDS auxiliaires](https://docs.xbox.com/fr-CA/reference/live/rest/additional/eds-apis.md)
- [Validate Api Policy](https://docs.xbox.com/api-reference/authentication/validate-api-policy.md)
- [Stratégie d'API](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands/playfab/api-policy.md)
- [API XTF supplémentaires (contenu de l'API)](https://docs.xbox.com/fr-CA/reference/tools/xtf/xtfapi/atoc-xtfapi.md)
