Skip to main content

​
Vue d’ensemble de l’API REST

Bienvenue dans la référence de l’API REST PlayFab. Vous y trouverez de la documentation de référence et découvrirez le fonctionnement de nos API. Chaque référence d’API est divisée en plusieurs sections.

​
Point de terminaison

Le point de terminaison est l’URL HTTP sur laquelle vous pouvez effectuer des requêtes d’API. Il est précédé d’un type de méthode REST (par exemple, GET, POST). En outre, 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 objet envoyé (au format JSON) à notre service d’API. Ces modèles contiennent des propriétés qui doivent être envoyées avec votre API en tant que charge utile. Certaines propriétés sont marquées comme obligatoires, tandis que d’autres sont facultatives.

​
Réponses

Le service d’API retourne un 200 OK avec une charge utile JSON qui peut être désérialisée en tant que modèle. Dans l’exemple ci-dessous, les appels d’API de connexion sont désérialisés en un type LoginResult. Exemple de réponse 200 OK avec un LoginResult Si la réponse échoue, une réponse d’erreur 4XX est reçue. Une erreur 400 Bad Request peut souvent être due à des paramètres manquants dans votre appel d’API ou à d’autres raisons, comme le dépassement des limites de débit et des erreurs de validation. Si vous rencontrez une erreur 4XX, il est préférable de vérifier les paramètres de la requête et le jeton d’authentification et de vous assurer qu’ils sont corrects. L’objet ApiErrorWrapper contient des informations précieuses sur l’erreur, notamment les codes d’erreur, les détails de l’erreur et les messages d’erreur du serveur, pour vous aider à identifier le problème.

​
Sécurité

Chaque API dispose d’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 issu d’une requête de connexion, ou de la clé secrète de votre titre si vous effectuez des requêtes d’API serveur.

​
Accès concurrentiel

Le service d’API est conçu pour gérer un très grand nombre d’appels simultanés de chaque titre, mais il existe des limites et des restrictions sur le nombre d’appels simultanés pouvant accéder à un même joueur ou à une autre entité unique, comme un personnage ou un groupe. Si cette limite d’accès concurrentiel est dépassée, l’API retourne un code d’erreur APIConcurrentRequestLimitExceeded ou ConcurrentEditError. En général, il est sûr d’effectuer plusieurs requêtes de lecture simultanées pour un joueur donné, mais il est préférable d’effectuer une seule requête de mise à jour à la fois.

​
Définitions des modèles

Chaque réponse du service d’API peut contenir un ou plusieurs modèles. Ceux-ci se trouvent sous l’ApiErrorWrapper et chaque modèle est représenté dans le même document que l’API. Chaque modèle est également lié dans le modèle parent de la réponse. Vous pouvez aussi consulter la section Définitions de chaque page d’API pour voir la liste des modèles pris en charge par l’API.

​
Définitions des modèles d’événements

La référence des modèles d’événements PlayStream contient les modèles des types d’événements PlayStream générés automatiquement. Chaque type d’événement possède un ensemble de propriétés qui sont incluses dans les données de l’événement, quel que soit l’endroit où il est envoyé.
Last modified on October 6, 2026