跳到主要内容
快速开始

本页尚未翻译,当前显示英文版本。

API key 管理

API key 向 PlayServ 表明调用方属于哪个 Project 的哪个 Environment。 游戏客户端、你的服务器、CLI 和 CI 都用它来认证。key 位于 Projects 页面:选中一个 Project 卡片,卡片下方的 API keys 面板就会显示它在顶栏所选 Environment 中的 key。


key 类型

类型前缀用于权限
Serversk_你的后端、Game server、CI 和 CLIProject 运行时允许的一切操作,包括登录 CLI。务必保密。
Clientpk_发布给 Player 的游戏 build游戏客户端所需的操作:让 Player 登录、在各表的 访问规则 范围内读取数据、调用 Function 和接收 Event。可以安全地随游戏发布。

切勿把 server key 打包进游戏 build

任何人从你的 build 中提取出 server key,就能完全访问该 Project 的运行时。Player 只应拿到 client key。

每个 key 只属于一个 Environment。 dev key 在 prod 中无效,面板也只显示顶栏所选 Environment 的 key。

要查看或创建其他 Environment 的 key,请先在顶栏切换 Environment。为每个使用方单独发放 key(每位开发者一个、CI 一个、每台服务器一个),这样吊销其中一个不会影响其他使用方。


创建 key

打开 Create key

在 Projects 页面选中 Project,然后点击 API keys 面板中的 Create key。

命名并选择类型

输入一个能说明 key 用途的 Name,例如 prod-server-ci,选择 Server 或 Client,然后点击 Create key。

对话框会显示 key 所属的 Environment,即顶栏当前选中的 Environment。这里无法更改;如需为其他 Environment 创建 key,请关闭对话框,先切换 Environment。

保存密钥

完整的密钥会显示在 Save your token 中。密钥的格式为 sk_dev_ 或 pk_dev_ 后接 32 个字符。

关闭对话框前先保存密钥

密钥只显示一次。点击 I've saved it, close 之前,请把它复制到密码管理器或 CI 的 secret 中:PlayServ 无法再次显示它。如果丢失了,请 轮换 key 获取新的密钥。


key 列表

列显示内容
Name悬停可查看 key 的创建者和创建时间,点击可重命名。
Type · EnvServer 或 Client,以及所属 Environment。
Prefix密钥的开头和结尾,中间被遮盖。
Key IDkey 的永久 ID,带复制按钮。轮换密钥后保持不变。
Statuskey 最近一次使用的时间,或 never。30 天未使用的 key 显示为琥珀色。

可以按 Server 或 Client 筛选,并按 Last used、Created 或 Name 排序。列表上方的统计栏显示活跃 key 的数量和 30 天未使用的 key 的数量;点击后者,长期未用的 key 会排到最前面。


轮换密钥

key 菜单中的 Rotate secret 会替换它的密钥,并在 Save your new token 中显示一次新密钥。key 的名称、类型和 ID 保持不变。

旧密钥立即失效

轮换是硬切换:从那一刻起,仍在使用旧密钥的请求都会被拒绝。请先更新服务器和 CI,或者准备好立即更新。已经建立的连接会保持打开。

server key 可能泄露时,或按计划定期轮换。

轮换 client key 会切断已发布的 build

游戏每次续期 Player 的 Session(大约每 15 分钟一次)都会用到 client key。轮换之后,所有使用旧 key 的 build 都会丢失 Session,在 Player 安装使用新 key 的 build 之前无法让 Player 登录。使用新 key 的 build 也找不到设备上保存的匿名 Player,会新建一个。只有在 client key 泄露时才轮换它。


吊销 key

key 菜单中的 Revoke 会立即让该 key 无法认证,并关闭所有使用它的实时连接。

时间结果
Undo60 秒内,该行和通知中都会显示带倒计时的 Undo。撤销会恢复 key,但已关闭的连接不会恢复。
60 秒后key 移到折叠的 Revoked 分组中,可以看到它被谁、在何时吊销。无法再恢复。

正在吊销中的 key 无法轮换,除非先撤销吊销操作。当某个使用方应当整体失去访问权限时,吊销 key;只是密钥泄露时,轮换 key。


后续步骤

更新于 2026年10月15日