获取Steam用户公开摘要
想在你的网站或应用中展示用户的 Steam 个人资料?这个接口就是为你准备的。
用户的 Steam 标识。可以是以下任意一种格式:
- 纯数字的 SteamID64
- 用户的 自定义 URL 名称 (Vanity URL)
- 完整的 个人资料链接 (包含 SteamID64 或自定义名称)
- 好友代码 (如
22202
)
用户的 Steam 自定义URL名称(Vanity URL)。例如个人资料链接中 /id/
后面的部分。
用户的 Steam ID3 格式标识符。传统的 Steam ID 格式,形如 STEAM_X:Y:Z。
你的 Steam Web API Key。这是一个可选参数,如果提供,它将覆盖我们在后端配置的全局Key。这为你提供了更大的灵活性,但请务必注意Key的保密,不要在前端暴露。
功能概述
通过一个用户的 Steam 标识(支持多种格式),你可以获取到他公开的个人资料摘要,包括昵称、头像、在线状态、真实姓名(如果公开)和个人资料主页URL等信息。
支持的参数格式
接口现在支持以下几种标识符格式:
steamid
: 64位SteamID(如76561197960287930
)id
: 自定义URL名称(如gabelogannewell
)id3
: Steam ID3格式(如STEAM_0:0:22202
)- 完整的个人资料链接
- 好友代码
使用须知
API Key 安全
此接口需要一个 Steam Web API Key。我们强烈建议由后端统一配置和调用,以避免在客户端泄露。当然,你也可以通过 key
查询参数临时提供一个Key来覆盖后端配置。
在处理响应时,请注意以下数字代码的含义:
personastate
(用户状态): 0-离线, 1-在线, 2-忙碌, 3-离开, 4-打盹, 5-想交易, 6-想玩。communityvisibilitystate
(社区可见性): 1-私密, 3-公开 (API通常只能查到这两种状态)。
查询参数
用户的 Steam 标识。可以是以下任意一种格式:
- 纯数字的 SteamID64
- 用户的 自定义 URL 名称 (Vanity URL)
- 完整的 个人资料链接 (包含 SteamID64 或自定义名称)
- 好友代码 (如
22202
)
用户的 Steam 自定义URL名称(Vanity URL)。例如个人资料链接中 /id/
后面的部分。
用户的 Steam ID3 格式标识符。传统的 Steam ID 格式,形如 STEAM_X:Y:Z。
你的 Steam Web API Key。这是一个可选参数,如果提供,它将覆盖我们在后端配置的全局Key。这为你提供了更大的灵活性,但请务必注意Key的保密,不要在前端暴露。
响应
200 / 请求成功
查询成功!返回用户的 Steam 公开资料摘要。
400 / 错误的请求
请求失败。请检查你是否提供了 steamid
、id
或 id3
中的任意一个参数。
401 / 未经授权
认证失败。你提供的 Steam Web API Key 无效或已过期,或者你没有提供 Key。请检查你的 Key。
404 / 未找到
用户未找到。根据你提供的 SteamID 未能找到对应的用户,或者该用户资料为完全私密。
502 / 网关错误
上游服务错误。在向 Steam 的官方 API 请求数据时遇到了问题。这可能是他们的服务暂时中断,请稍后重试。