通过

REST API概述

  • 项目

欢迎使用 PlayFab REST API参考。 在这里，你将找到参考资料，并深入了解我们的 API 的工作原理。 每个 API 参考都细分为几个不同的部分。

终结点

终结点是您可以对其发起 API 请求的 HTTP URL。 它的前面是一个 REST 方法类型（例如 GET、POST）。 此外，titleId 必须替换为游戏的 titleId。

示例：

POST https://[titleId].playfabapi.com/Client/LoginWithCustomID

请求正文

请求正文是以 (JSON) 形式发送给 API 服务的对象模型。 这些模型包含需要作为有效负载随 API 一起发送的属性。 某些属性标记为必需，另一些属性标记为可选。

响应

API 服务会返回 200 OK 以及可以反序列化为模型的 JSON 有效负载。 在下面的示例中，登录 API 调用会反序列化为 LoginResult 类型。

使用 LoginResult 的示例 200 OK 响应

如果响应失败，会收到 4XX 错误响应。 400 错误请求通常是由于 API 调用中缺少参数或其他原因（例如超出速率限制和验证错误）导致的。 如果遇到 4XX 错误，最好检查请求参数和身份验证令牌，并确保它们正确无误。 ApiErrorWrapper 对象包含有关错误的重要信息，包括错误代码、错误详细信息以及来自服务器的错误消息，它们可帮助识别问题。

安全性

每个 API 都具有某种形式的安全性，需要在每个请求的标头中进行传递。 请参阅这一部分以了解需要定义的内容。 有时是来自登录请求的会话票证，如果正在进行服务器 API 请求，则也可能是游戏密钥。

并发

API 服务旨在处理来自每个游戏的大量并发调用，但是对于可访问单个玩家或其他单个实体（例如角色或组）的并发调用数，存在限制。 如果超出此并发限制，API 会返回 APIConcurrentRequestLimitExceeded 或 ConcurrentEditError 错误代码。 通常，为一名给定玩家同时发出多个读取请求没有风险，但最好一次发出一个更新请求。

模型定义

来自 API 服务的每个响应都可以在响应中包含一个或多个模型。 这些模型位于 ApiErrorWrapper 下，每个模型都在与 API 相同的文档中表示。 每个模型还链接在响应父模型中。 您还可以访问每个 API 页面的“Definitions”部分，查看 API 支持的模型的列表。

事件模型定义

PlayStream 事件模型参考包含自动生成的 PlayStream 事件类型的模型。 每个事件类型都有一组作为事件数据的一部分（无论发送到哪里）包含在内的属性。