跳转到主要内容
PlayFab 开发者密钥允许你的 Title 进行 PlayFab Admin 和服务器 API 调用。密钥也称为开发者密钥,与 PlayFab Title 强耦合。 使用 Game Manager 中的 Secret Keys 页面,你可以创建、删除、禁用和设置密钥过期。这使你能够轮换 title 的密钥(这在过去很难做到)。它还允许你授予对 title 的临时访问权限。
切勿在发送给客户的客户端构建中包含你的开发者密钥。这样做会使你的 title 面临被滥用的风险。
要管理 Title 的密钥:
  1. 登录到 Game Manager。
  2. 选择你的 Title。
  3. 在右上角,选择齿轮图标。
  4. 选择 Title settings,然后选择 Secret Keys 选项卡。
Secret Keys 页面提供选项以删除密钥,查看每个密钥的状态、名称、值及其过期时间(如果有的话)。此表格可让你审计可用的密钥。 你可以通过仪表板重命名、启用、禁用现有密钥或为其设置过期时间。要查看某个密钥的选项,请选择它。每个 title 都从默认密钥开始。 要轮换密钥:
  1. 选择 New Secret Key。
  2. 输入密钥的名称和可选的过期日期。
  3. 更新你的代码以使用新密钥。
  4. 禁用旧密钥。选择旧密钥,然后在 Edit Secret Key 页面上选中 Disable 复选框。
  5. 选择 SAVE SECRET KEY。
Game Manager - Settings - Edit Secret Key
如果你的旧密钥被泄露,请轮换密钥以将 Title 恢复到安全状态。
此流程无停机时间,在删除旧密钥之前,你可以安全地回滚每个步骤。如果在第一步出现问题,你可以删除新密钥。此时不应有任何人使用它。 在第二步,两个密钥都处于活动状态,因此你可以安全地向前推进代码或回滚。 在第三步,你可以在修复仍然依赖它的任何内容时重新启用密钥。 流程完成后,你不需要删除旧密钥。如果你删除该密钥,就无法恢复。删除是永久性且不可撤销的。 将密钥设置为过期在你需要为某人提供对 Title 的临时访问时很有用。 例如,如果你有一名承包商正在开发你的游戏,你可以给他们只在你预期他们需要访问的时间段内有效的密钥。如果他们需要在原定过期日期之后继续访问,你可以重置过期日期以延长密钥的生命周期。

IP 允许列表

title 密钥的 IP 允许列表是一项安全功能,可确保 title 密钥不能在你信任的 IP 之外使用。每个密钥都可以携带自己的 IPv4 或 IPv6 地址列表(或 CIDR 范围),允许使用它。 当为 title 密钥配置了 IP 允许列表时,使用该密钥进行的特权调用(Server 和 Admin API)只有在源 IP 与列表中的条目匹配时才会被接受。来自任何其他 IP 的调用都会被拒绝,即使密钥本身在其他方面是有效的。对密钥的每个更改(包括允许列表的编辑)都会在现有的 PlayStream 密钥更改事件中被捕获。 支持的格式:
  • 同时支持 IPv4 和 IPv6 地址(例如 203.0.113.7 或 2001:db8::1)。
  • 支持任一族的 CIDR 范围(例如 203.0.113.0/24 或 2001:db8::/32)。
如何为你的 title 密钥配置 IP 允许列表:
  1. 在 Game Manager 中,导航到 Title Settings > Secret Keys。
  2. 编辑(或创建)密钥。
  3. 打开 Enable IP allowlist。
  4. 添加你的出口 IP 或 CIDR 范围,每行一个(例如 203.0.113.7 或 2001:db8::/32)。
  5. 选择 Save。
保存前请仔细检查列表。错误的条目会阻止列表中未包含的每个 IP,这可能会使你的服务无法访问 Server 和 Admin API。

API 允许列表

API 允许列表将 title 密钥限制为一组特定的 PlayFab API。对允许列表之外的 API 的请求将返回 HTTP 403(NotAuthorized)。对密钥的每个更改(包括 API 允许列表的编辑)都会在现有的 PlayStream 密钥更改事件中被捕获。 没有 API 允许列表的密钥仍然不受限制。在你启用并配置 API 允许列表之前,现有密钥不受影响。
选择所有 API 会创建当时可用 API 的快照。它不是通配符,之后添加的 API 不会被自动允许。若要使密钥对当前和将来的 API 都不受限制,请不要启用 API 允许列表。
允许 GetEntityToken 可能会提供超出预期的访问权限。此 API 返回的实体令牌不受 title 密钥的 API 允许列表限制。
要配置 API 允许列表:
  1. 在 Game Manager 中,转到 Title Settings > Secret Keys。
  2. 编辑或创建密钥。
  3. 打开 Enable API allowlist。
  4. 使用 Search APIs 查找并选择每个所需的 API,例如 /Server/GetUserData。
  5. 选择 Save,然后确认更改。
API 允许列表的更改不会立即生效。它们会在现有密钥缓存过期时生效。若要撤销该密钥的所有访问权限,请禁用该密钥,而不是依赖 API 允许列表的更改。 要移除 API 限制:
  1. 编辑密钥。
  2. 关闭 Enable API allowlist。
  3. 选择 Save,然后确认更改。
之后,该密钥对当前和将来的 API 都不受限制。
最后修改于 2026年10月20日