Passer au contenu principal
La 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 à la place vos informations d’identification de développeur Microsoft Entra ID. Les API qui n’acceptent que des jetons d’entité de joueur ou de serveur de jeu ne sont pas autorisées de cette manière. Vous avez besoin de l’autorisation Admin sur le titre PlayFab. Consultez Fonctionnement de l’authentification PlayFab.

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.
Pour utiliser un autre titre pour une seule commande, passez --playfab-title-id. Consultez Contexte.

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 est rédigée pour les personnes.
  • Les spécifications Swagger de PlayFab sont lisibles par une 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 : recherchez 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 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é autorisés.
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, qui contient la référence complète des options. Les opérations Delete* et Shutdown* demandent d’abord confirmation dans un terminal, et nécessitent --confirm ailleurs ; consultez Sécurité et opérations destructives.

Obtenir les données de titre

Obtenir une seule clé de données de titre

Définir des données de titre

Passez le corps de la requête directement avec --body :
Vous pouvez aussi le lire à partir d’un fichier avec --body-file, ici dans PowerShell :

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 à transmettre à une autre commande :

Réponses d’erreur

Un appel en échec 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.
Dernière modification le 19 novembre 2026