Skip to main content

Información general de la API REST

Le damos la bienvenida a la referencia de la API REST de PlayFab. Aquí encontrará material de referencia y obtendrá información sobre cómo funcionan nuestras API. Cada referencia de API se divide en varias secciones diferentes.

Punto de conexión

El punto de conexión es la URL HTTP contra la que puede hacer solicitudes de API. Va precedido de un tipo de método REST (por ejemplo, GET, POST). Además, el titleId debe reemplazarse por el titleId de su juego. Ejemplo:

Cuerpo de la solicitud

El cuerpo de la solicitud es el modelo de objeto que se envía (como JSON) a nuestro servicio de API. Estos modelos contienen propiedades que deben enviarse junto con la API como carga útil. Algunas propiedades están marcadas como obligatorias, mientras que otras son opcionales.

Respuestas

El servicio de API devolverá un 200 OK con una carga JSON que puede deserializarse como un modelo. En el ejemplo siguiente, las llamadas a la API de inicio de sesión se deserializan en un tipo LoginResult. Si la respuesta falla, se recibe una respuesta de error 4XX. Un 400 Bad Request a menudo puede deberse a la falta de parámetros en la llamada de API o a otros motivos, como superar los límites de velocidad y errores de validación. Si encuentra un error 4XX, lo mejor es comprobar los parámetros de la solicitud y el token de autenticación y asegurarse de que son correctos. El objeto ApiErrorWrapper contiene información valiosa sobre el error, incluidos códigos de error, detalles del error y mensajes de error del servidor para ayudar a identificar el problema.

Seguridad

Cada API tiene algún tipo de seguridad que debe pasarse en el encabezado de cada solicitud. Consulte esta sección para saber qué debe definirse. A veces es un vale de sesión de una solicitud de inicio de sesión, o podría ser la clave secreta de su título si está haciendo solicitudes de API de servidor.

Simultaneidad

El servicio de API está diseñado para gestionar un número muy elevado de llamadas simultáneas de cada título, pero existen límites y restricciones en el número de llamadas simultáneas que pueden acceder a un solo jugador u otra entidad individual, como un personaje o un grupo. Si se supera este límite de simultaneidad, la API devuelve un código de error APIConcurrentRequestLimitExceeded o ConcurrentEditError. En general, es seguro hacer más de una solicitud de lectura para un jugador determinado de forma simultánea, pero es mejor hacer una sola solicitud de actualización cada vez.

Definiciones de modelos

Cada respuesta del servicio de API puede contener uno o varios modelos. Estos se encuentran debajo del objeto ApiErrorWrapper y cada modelo se representa en el mismo documento que la API. Cada modelo también está vinculado en el modelo primario de la respuesta. También puede visitar la sección Definitions de cada página de API para ver una lista de los modelos compatibles con la API.

Definiciones de modelos de eventos

La referencia del modelo de eventos de PlayStream contiene los modelos de los tipos de eventos de PlayStream generados automáticamente. Cada tipo de evento tiene un conjunto de propiedades que se incluyen como parte de los datos del evento allá donde se envíe.
Última modificación el 28 de agosto de 2026