xbox) est conçue pour être exécutée par des agents d’IA et des scripts aussi bien que par des personnes. Ses
commandes acceptent des arguments explicites, ses commandes de données écrivent du JSON, et ses erreurs sont envoyées à stderr
avec un code de sortie différent de zéro. Cette page s’adresse aux agents et aux personnes qui les configurent : comment
se connecter, choisir ce sur quoi une commande agit, lire sa sortie et trouver la bonne API, et quoi
demander avant de modifier quoi que ce soit.
Avant de modifier quoi que ce soit
L’utilisateur connecté dispose habituellement de droits d’administrateur sur les titres et les vendeurs de production, et rien du côté serveur n’empêche un appel erroné. Sécurité et opérations destructrices répertorie ce pour quoi la CLI demande une confirmation et ce pour quoi elle n’en demande pas. Le reste vous incombe :- Considérez une opération PlayFab comme étant en lecture seule uniquement si son nom commence par
Get,ListouSearch. Considérez toute autre opération, et toute commandexboxqui crée, modifie ou supprime quelque chose, comme une modification de production. - Avant une modification de production, montrez la commande à l’utilisateur et indiquez en une phrase ce qu’elle
modifie et sur quel titre ou vendeur, en précisant si cette cible provient du contexte
enregistré. Exécutez-la uniquement après qu’il a dit oui, même si votre environnement d’exécution exécuterait
xboxsans demander. Un oui couvre uniquement les appels que vous avez montrés. - Passez le titre ou le vendeur sous forme d’indicateur pour chaque modification de production. Le contexte enregistré est partagé par toutes les sessions de l’utilisateur du système d’exploitation; il peut donc changer entre le oui de l’utilisateur et votre appel.
- Demandez avant
xbox pc sandbox set, qui change le sandbox pour tous les utilisateurs du PC, et avantxbox pc sandbox launch-apps, qui ferme le Microsoft Store et l’application XBOX. - N’ajoutez pas
--confirm(ni--yes) au lieu de demander. La CLI ne peut pas savoir qui l’a ajouté. - Avant de demander à publier dans RETAIL avec
xbox xbl config publish, exécutez la commande avec--validate-onlyet montrez à l’utilisateur les succès qu’elle répertorie. Publiez ensuite avec--configsetdéfini sur la valeurSourceVersionde sa sortie JSON. Les succès dans RETAIL ne peuvent pas être retirés; consultez Succès ajoutés par une publication dans RETAIL. - Si une modification de production échoue et que son résultat est inconnu, elle a peut-être été appliquée. Lisez l’état concerné avant de réessayer; consultez Une écriture interrompue signale que son résultat est inconnu.
- Ne touchez pas au contexte enregistré, sauf si l’utilisateur vous demande de le modifier.
xbox context set,xbox context unsetetxbox context profile deletemodifient les valeurs par défaut de toutes les sessions.
Connexion
auth status se termine avec le code 0 et signale {"signedIn":false} lorsque personne n’est connecté;
basez donc votre logique sur signedIn. Un code de sortie différent de zéro signifie que la vérification n’a pas pu être effectuée, et l’erreur figure sur stderr.
Les appels PlayFab échouent, sauf si l’utilisateur connecté dispose de l’autorisation Admin sur le titre. Consultez
Authentification.
Choisir le titre ou le vendeur
Passez le titre ou le vendeur sous forme d’indicateur, comme--playfab-title-id ABC123. Sans indicateur, une
commande utilise une variable d’environnement XBOX_ ou une valeur enregistrée avec xbox context set; consultez
Contexte pour savoir laquelle l’emporte. Exécutez xbox context get --output json-compact pour
voir ce qui est enregistré, et confirmez le titre une fois avec l’utilisateur avant d’appeler quoi que ce soit
d’important.
Lire la sortie
Combinez--data-only et --output json-compact pour obtenir uniquement la charge utile, sur une seule ligne :
--data-only, stdout est
vide en cas d’erreur; vérifiez donc le code de sortie avant d’analyser stdout.
playfab file upload, download et delete n’écrivent rien sur stdout, et leurs messages sur stderr
peuvent changer; vérifiez donc leur code de sortie. Consultez Fichiers.
L’aide signale les commandes expérimentales, dont l’interface peut changer. Consultez
Commandes expérimentales.
Limites de débit
Lorsqu’un service XBOX répond HTTP 429, attendez avant de réessayer; la CLI ne réessaie pas à votre place. Lorsque le service précise un délai d’attente, l’erreur indique le nombre de secondes, et les erreurs structurées le contiennent aussi dansretryAfterSeconds. Un code 429 avec le code d’erreur rate_limited signifie que vous avez envoyé trop
de requêtes en peu de temps; ralentissez donc.
Trouver la bonne API PlayFab
xbox playfab api <api-path> appelle n’importe quelle opération de l’API PlayFab. Le chemin est
/<Prefix>/<Operation>, comme /MultiplayerServer/ListBuildSummariesV2, et le corps de la
requête est l’objet de requête JSON de l’opération. PlayFab documente les deux :
- Les spécifications Swagger de PlayFab
sont lisibles par machine. Chaque fichier répertorie ses opérations par chemin, avec leurs schémas de requête et
de réponse et leurs champs obligatoires. 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
pathsdes fichiers :/Cataloget/Inventoryse trouvent dansEconomy.swagger.json, et/Match,/Lobbyet/MultiplayerServerse trouvent dansMultiplayer.swagger.json. Le champsecurityde chaque opération nomme les informations d’identification qu’elle accepte :SecretKey,EntityToken,SessionTicketouNonepour les opérations qui n’en nécessitent aucune, comme les appels de connexion des joueurs. Certaines opérations indiquent également dans leur description les types de jetons d’entité qu’elles autorisent. - La référence de l’API REST PlayFab couvre les mêmes opérations à l’intention des personnes.
SessionTicket de joueur, ou qui acceptent uniquement des jetons d’entité de joueur ou
de serveur de jeu, ne sont donc pas autorisées. Lorsqu’un appel échoue, sa réponse d’erreur indique habituellement le problème, comme
InvalidParameter ou MissingParameter. Consultez Intégration de l’API PlayFab pour
en savoir plus.
Dans Git Bash sous Windows, définissez MSYS_NO_PATHCONV=1 pour la commande, car sinon Git Bash
convertit le chemin de l’API en chemin Windows avant que la CLI le reçoive. Consultez
Exécution à partir de Git Bash sous Windows.
Garder les secrets hors des journaux
- Lorsqu’un corps de requête peut contenir des secrets, passez-le avec
--body-fileplutôt qu’avec--body, afin qu’il reste hors de l’historique du shell et des listes de processus.playfab mps certificate uploadetplayfab mps secret uploadrefusent--body, car leur corps en contient toujours un. - Gardez les secrets hors des fichiers de configuration et des variables d’environnement.
ClientId,TenantIdet les étendues OAuth sont des identificateurs, et non des secrets. - Les réponses PlayFab peuvent contenir des données de joueur, d’inventaire ou d’économie. Le masquage, la conservation et le contrôle de l’accès à tout ce qu’un agent consigne relèvent du propriétaire de l’agent.
Voir aussi
- Commandes : la référence complète des commandes
- Sécurité et opérations destructrices : ce qui demande une confirmation, et ce qui fait plus que ce qu’indique son nom
