Vue d’ensemble de l’API REST
Bienvenue dans la référence de l’API REST PlayFab. Vous y trouverez du matériel de référence et découvrirez le fonctionnement de nos API. Chaque référence d’API est divisée en plusieurs sections distinctes.Point de terminaison
Le point de terminaison est l’URL HTTP à laquelle vous pouvez envoyer des requêtes d’API. Il est précédé d’un type de méthode REST (par exemple, GET, POST). De plus, le titleId doit être remplacé par le titleId de votre jeu. Exemple :Corps de la requête
Le corps de la requête est le modèle d’objet envoyé (en JSON) à notre service d’API. Ces modèles contiennent des propriétés qui doivent être envoyées avec votre API comme charge utile. Certaines propriétés sont marquées comme obligatoires, tandis que d’autres sont facultatives.Réponses
Le service d’API retournera un 200 OK avec une charge utile JSON qui peut être désérialisée en modèle. Dans l’exemple ci-dessous, les appels de l’API Login sont désérialisés en un type LoginResult.
Sécurité
Chaque API comporte une forme de sécurité qui doit être transmise dans l’en-tête de chaque requête. Consultez cette section pour savoir ce qui doit être défini. Il s’agit parfois d’un ticket de session provenant d’une requête de connexion, ou ce pourrait être la clé secrète de votre titre si vous effectuez des requêtes d’API serveur.Concurrence
Le service d’API est conçu pour gérer un très grand nombre d’appels simultanés provenant de chaque titre, mais il existe des limites et des restrictions quant au nombre d’appels simultanés pouvant accéder à un seul joueur ou à une autre entité unique, comme un personnage ou un groupe. Si cette limite de concurrence est dépassée, l’API retourne un code d’erreurAPIConcurrentRequestLimitExceeded ou ConcurrentEditError. En général, il est sûr d’effectuer plus d’une requête de lecture simultanément pour un joueur donné, mais il est préférable d’effectuer une seule requête de mise à jour à la fois.