选择 SDK
Sudomimus 提供两层 SDK。框架 SDK 为受支持的 Web 框架处理 Connect callback、服务端路由、cookie、重定向和 session 轮换。API SDK 为自行管理这些流程的应用提供强类型客户端和 token 辅助功能。API SDK 客户端基于公开的 OpenAPI 3.1 契约;框架 SDK 构建在 API SDK 之上。
选择接入方式
Section titled “选择接入方式”- Next.js、React Router、Nuxt 或 Django 服务端应用:从框架 SDK开始。
- 其他运行时,或需要自行管理 Connect、Session、Device、Native 流程的应用:在下方按语言选择 API SDK。
- 需要精确 wire contract、接入未支持的语言或自行生成客户端:查看 API 参考文档。
API SDK 覆盖范围
Section titled “API SDK 覆盖范围”| 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。 |
按语言选择 API SDK
Section titled “按语言选择 API SDK”TypeScript / JavaScript面向 Node.js 与合适浏览器运行时的当前包可用性和 API 支持范围。
Python面向 Python 应用的当前包可用性与 API 支持范围。
C#面向 .NET 应用的当前包可用性和 API 支持范围。
Go面向 Go 服务的当前 module 可用性与 token 验证覆盖。
JavaJDK 17 modules 当前的源码与发布状态。
框架 SDK
Section titled “框架 SDK”框架 SDK 指南介绍受支持的框架,并链接到各包的接入指南。框架 SDK 处理 Web 登录和 session 生命周期;底层操作仍可使用 API SDK。
API SDK 包模型
Section titled “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 的服务。
底层协议仍由各集成指南说明:
Connect 集成浏览器登录、状态轮询、callback 与 redeem。
设备码授权公开客户端的 device-code 登录。
原生应用集成Steam ticket 与 AccessKey direct-issue。
管理会话Refresh、introspection、logout 与 revoke-all。
SDK monorepo所有官方 SDK 包的源码、README、issue 与发布标签。
OpenAPI 契约API SDK 客户端依据的权威公开 schema。