Sytronic Hub Developer Platform
API 开发文档
用一套 REST API 接入 Sytronic Hub 的视频、图文、动态、评论与用户数据。这里是给开发者的快速起点:认证、分页、错误约定和常用端点。
REST / JSON
JWT Bearer
v1
HTTPS only
快速开始
所有请求都走 HTTPS。先用账号密码换取 access token,再在请求头中携带 Bearer token。
1. 获取 Token
curl -X POST "https://api.sytronichub.com/v1/token/" \
-H "Content-Type: application/json" \
-d '{"username":"your_username","password":"your_password"}'成功时返回 access 与 refresh;access 过期后用 refresh 换新。
2. 发起请求
curl "https://api.sytronichub.com/v1/categories/" \
-H "Authorization: Bearer <access_token>"网页端同源开发也可以使用 Django Session 登录态;第三方客户端请使用 JWT,不要把登录密码保存在客户端。
认证与权限
| 方式 | 请求头 | 适用 |
|---|---|---|
| JWT | Authorization: Bearer <access> | 第三方客户端、移动端、桌面端 |
| Session | Cookie: sessionid | 同源网页 / 调试 |
| Public | 无需认证 | 只读的公开内容 |
Token 端点
| Method | Path | Description |
|---|---|---|
| POST | /v1/token/ | 用 username / password 获取 access + refresh |
| POST | /v1/token/refresh/ | 用 refresh 获取新的 access |
Token 端点有独立的 10 次 / 分钟限流。不要把 client secret、密码或 refresh token 写进前端代码。
常用端点
完整列表以 API 根返回为准;下表是最常用的资源入口。所有路径均相对于 Base URL。
| 资源 | Path | 读权限 | 写权限 |
|---|---|---|---|
| Video | /v1/videos/ | 公开 | 作者 |
| Article | /v1/articles/ | 公开 | 作者 |
| Feed | /v1/feeds/ | 公开 | 作者 |
| Comments | /v1/comments/ | 公开 | 登录用户 |
| 分类 / 标签 | /v1/categories/ /v1/tags/ | 公开 | — |
| User | /v1/users/ | 公开资料 | — |
| Favorites | /v1/collections/ | 公开收藏夹 | 本人 |
| 公告 / 更新日志 | /v1/announcements/ /v1/changelogs/ | 公开 | — |
视频列表接口按 id 查询单个视频;文章、动态、评论等列表使用标准分页。写操作通常需要作者或管理员权限。
通用约定
Pagination
列表默认每页 20 条,使用 page 参数翻页;响应包含 count、next、previous、results。
限流
| 身份 | 限额 |
|---|---|
| Anonymous | 120 / 分钟 |
| 已登录用户 | 600 / 分钟 |
| Token 获取 / 刷新 | 10 / 分钟 |
Status code
| Status code | 含义 |
|---|---|
| 400 | 请求参数不合法 |
| 401 | 未登录或 Token 无效 |
| 403 | 已登录但无权限 |
| 404 | 资源不存在或不可见 |
| 429 | 触发限流,请按 Retry-After 重试 |
帮助与支持
遇到接口、OAuth 应用或回调域名问题时,先查阅帮助中心;仍然无法解决时再提交反馈。