快速入门:Postman 的 PlayFab REST API 集合

Postman 的 PlayFab REST API 集合入门。 按照步骤安装程序包,并尝试使用基本任务的示例代码。 PlayFab 是用于实时游戏的完整后端平台。 使用 Postman 的 PlayFab REST API集合执行以下操作:

  • 获取实体令牌
  • 在标题中添加/修改/删除实体
  • 配置游戏内容

API 参考文档 | PlayFab Postman Collection GitHub 存储库

先决条件

添加 PlayFab 集合

  • 创建工作区

    Postman 选择创建工作区

    Postman 创建工作区

  • 选择“导入(窗口左上角)

    Postman 导入

  • 选择“链接

    Postman 选择“从链接导入”

    Postman 从链接导入

  • 将以下链接粘贴到 URL 文本框中,然后选择“继续”和“导入

    https://raw.githubusercontent.com/PlayFab/PostmanCollection/master/playfabV2.json

    • 如果正在尝试下载 Beta SDK,请转到 Postman Beta GitHub 存储库中的 playfabV2.json 文件

    • 选择 查看原始

      Postman 查看原始 Beta 版 JSON

    • 从浏览器复制 URL,将链接粘贴到 URL 文本框中,然后选择“继续”和“导入

  • 现在应该会在"集合"选项卡下看到 PlayFab Postman SDK (窗口左上角)

    Postman PlayFab 集合

添加环境变量

  • 选择“环境”和“创建环境”以创建新环境

    Postman 管理环境

  • 为环境命名 - 建议使用"[titleId] - 测试环境"

注意

你可以通过登录到 Game Manager 并在"我的工作室和游戏"主页上复制游戏名称下方的十六进制值来查找游戏 ID。

  • 将以下 3 个变量添加到环境中:

    可变 初始值 当前值
    TitleId [titleId] [titleId]
    SecretKey [secretKey] [secretKey]
    EntityToken

注意

你可以在 机密密钥管理 文档中详细了解游戏密钥及其查找位置。

Postman 创建环境

  • 完成后,选择“保存”以保存新环境

  • 选择环境下拉列表以切换到新环境(窗口右上角)

    Postman 选择环境

获取游戏实体令牌

与 PlayFab 的 实体编程模型 交互的一种方法是获取游戏实体令牌。 如果要更改游戏配置数据,或者要对大量玩家进行调整,这可能很有用:

  • PlayFab Collections 文件夹下,展开 Authentication 命名空间,然后选择 GetEntityToken

  • 在“标头”下,取消选中 X-Authorization

    Postman 获取实体令牌标头

  • 选择 发送

  • 将返回的实体令牌设置为 EntityToken 环境变量

    • 在响应中,突出显示 EntityToken 字符串

    • 右键单击并选择 设置:[环境] 新环境

    • 选择 EntityToken

      Postman 设置实体令牌变量

注意

实体令牌在24 小时后过期。 之后,需要重新运行 GetEntityToken 以获取新的实体令牌并更新环境变量

获取Title_Player_Account实体令牌

与 PlayFab 的 实体编程模型 交互的另一种方法是获取Title_Player_Account实体令牌。 如果要对单个玩家进行更改,这非常有用:

  • PlayFab Collections 文件夹下,展开 Client 命名空间,然后选择 LoginWithCustomID
  • 在“正文”下,将 CreateAccount 值从 false 更改为 true
  • 选择 发送
  • 将返回的实体令牌设置为 EntityToken 环境变量
    • 在响应中,突出显示 EntityToken 字符串

    • 右键单击并选择 设置:[环境] 新环境

    • 选择 EntityToken

      Postman 获取 Title_Player_Account 实体令牌

故障排除

  • 标题 ID/密钥不匹配
    • 如果尝试获取游戏实体令牌并收到401: Unauthorized错误,请通过登录到 Game Manager确保游戏 ID 和密钥正确无误
  • 过期的实体令牌
    • 如果之前获取了实体令牌,但未成功尝试调用其他 API,则实体令牌可能已过期。 获取另一个实体令牌,将其保存到 EntityToken 环境变量中,然后再次尝试调用以前的 API
  • 实体令牌类型不正确
    • 有不同类型的实体(请参阅 可用的内置实体类型)。 不同的 API 允许不同的实体类型 - 例如,你可能尝试使用title_player_account实体令牌(而不是游戏实体令牌)调用GetLanguageList
  • 环境不正确:
    • 通过检查环境下拉列表(窗口右上角)来确保使用正确的环境

后续步骤

现在,你有一个实体令牌可以传递到其他 API 调用,以开始设置 PlayFab 游戏。