跳转到内容

选择 SDK

查看 Markdown

Sudomimus 提供两层 SDK。框架 SDK 为受支持的 Web 框架处理 Connect callback、服务端路由、cookie、重定向和 session 轮换。API SDK 为自行管理这些流程的应用提供强类型客户端和 token 辅助功能。API SDK 客户端基于公开的 OpenAPI 3.1 契约;框架 SDK 构建在 API SDK 之上。

  • Next.js、React Router、Nuxt 或 Django 服务端应用:从框架 SDK开始。
  • 其他运行时,或需要自行管理 Connect、Session、Device、Native 流程的应用:在下方按语言选择 API SDK。
  • 需要精确 wire contract、接入未支持的语言或自行生成客户端:查看 API 参考文档。
API SDK 职责
Connect API 开启浏览器登录 inquiry、查询状态、兑换令牌、读取应用元数据。
Session API refresh 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 指南介绍受支持的框架,并链接到各包的接入指南。框架 SDK 处理 Web 登录和 session 生命周期;底层操作仍可使用 API SDK。

每个 API SDK 包对应一个 Sudomimus API。安装你要启动的流程对应的包;拿到 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 的服务。

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