Steamworks 文献库
使用 Web API 密钥进行验证
某些 Web API 方法在调用时会返回可公开访问的数据且无需授权。 其他的方法可能会要求您使用一个唯一的 API 密钥。 还有其他方法会返回敏感数据或执行受保护操作并要求特殊的访问权限。 这些 API 需要发行商密钥,您需在调用 API 前创建该密钥。 在必须使用 API 密钥的情况下,可以采用标准参数的形式来提供密钥,也可以通过设置“x-webapi-key”请求标头值来提供。

用户密钥

每人均可获得标准的用户密钥,所需要的只是 Steam 帐户及与该密钥关联的域名。

您还需要同意 Steam Web API 使用条款

您可在 Steam 社区注册页面创建用户 Web API 密钥。

发行商密钥

游戏开发者可以创建与其 Steamworks 发行商帐户相关联的 Web API 密钥。 这些密钥可用于访问公用及发行商专用 Web API 方法。

每个发行商密钥均与一个 Steamworks 发行商组关联。 发行商专用 Web API 方法通过以下方式控制密钥访问权限:
  • 发行商组 App ID:部分发行商方法要求在请求中提供的 appid 值与该密钥的发行商组相关联;
  • 密钥权限:所有发行商方法均有一个必须与请求的密钥相关联的权限组。 参考 Steamworks Web API 索引,了解哪些方法需要哪些权限;
  • IP 白名单:每个发行商密钥还可以锁定在特定的调用 IP 地址组上。

4 种 Web API 密钥权限分别为:
  • 小额交易:用于发起、完成及核对游戏内购买;
  • 销售数据:调用 IPartnerFinancialService API;
  • 经济体相关调用:适用于使用 Steam 物品库存服务的游戏;
  • 通用 API 调用:包括用户身份验证、DLC 所有权检查等不属于上述三类的其他 API 调用。

webapi_key_permissions.png
发行商 Web API 密钥可用于访问敏感用户数据及受保护方法。 这些密钥应该用于源自于安全发行商服务器的 Web API 请求。 密钥须安全存储,且不可通过游戏客户端分发。 所有包含 Web API 密钥的 Web API 请求应通过 HTTPS 进行。

创建发行商 Web API 密钥

您需有现有 Steamworks 帐户的管理权限方可创建发行商 Web API 密钥。 如您并非管理员,您可查看 Steamworks 主页右侧您合作伙伴帐户的管理员列表。 列表中任何一位管理员均可创建您的发行商 Web API 密钥或在合适的情况下将您晋升为管理员。

要创建发行商 Web API 密钥:
  1. 如果是具有您 Steamworks 帐户管理员权限的用户,在“用户与权限”下的“管理组”中访问组列表。
  2. 选择已有组或创建一个组。 我们推荐创建专用组,以控制 Web API 密钥对游戏的访问权限。
  3. 请在创建密钥前确保与组关联的应用正确。
  4. 选择创建 WebAPI 密钥
  5. 选择想要的密钥权限组。
  6. 选择保存更改
  7. 新建的密钥将显示在页面的右侧边栏中。