跳转到内容

选择 SDK

查看 Markdown

Sudomimus SDK 根据公开的 OpenAPI 3.1 契约生成。契约位于 sudomimus/sudomimus-spec。SDK 在原始 HTTPS API 之上提供请求和响应类型、JSON 序列化、client-auth 签名、JWT 解析、Session JWKS 缓存、签名验证辅助以及结构化 API 错误。

应用集成优先使用 SDK。需要排查底层请求、接入尚未支持的语言,或生成自己的客户端时,再参考 API 文档里的精确 wire contract。

APISDK 职责
Connect API开启浏览器登录 inquiry、查询状态、兑换令牌、读取应用元数据。
Session APIrefresh token 轮换、session introspection、单次 logout、按 subject revoke-all。
Device API开启 device-code 授权,并在用户批准后兑换 device code。
Native API用 Steam ticket 或 AccessKey 凭据兑换普通 Sudomimus token。
Token helpers解析并验证 Sudomimus access/refresh JWT。

每个 SDK 包对应一个 Sudomimus API surface。安装你要启动的流程对应的包;拿到 token 之后,再添加 Session 包处理 refresh token 生命周期。

  • Connect 是常见的 Web 应用登录流程。/establish 需要 client-auth 签名,因此它需要应用的 client-auth 私钥。
  • Device 面向 CLI、启动器、电视应用、终端等公开客户端,不需要 client secret。
  • Native 面向 Steam Web API auth ticket 和 Sudomimus AccessKey 这类原生凭据。
  • Session 处理初始签发之后的一切:refresh、introspection、logout、revoke-all。
  • Token 适合只验证 access/refresh token、不调用 API 的服务。

底层协议仍由各集成指南说明: