Bead 管理 开发者门户 · SQLite

文档 / 概览

REST API 说明

面向 APP 开发者的接口契约。左侧点进具体接口后,文档内可直接「模拟请求」测试。

基本信息

Base URL{host}/api
实际前缀/api
Content-Typeapplication/json
注册方式仅 Email
数据存储SQLite · 字段见「数据表」
多语言默认 en · 见侧栏 多语言

快速开始

  1. 调用 POST /auth/send-code(scene=register)发送注册验证码
  2. 调用 POST /auth/register 完成注册并拿到 token
  3. 已有账号用 POST /auth/login 登录
  4. access 过期后用 POST /auth/refresh 刷新;退出用 POST /auth/logout
  5. APP 请求带上 langAccept-Language,错误 message / 分类名会本地化
当前文档范围:认证 Auth、用户 User、图纸社区 Patterns。每个接口含完整 data 字段说明与 JSON 示例。多语言约定见 多语言

模块一览

  • 认证 Auth — 仅支持 Email 注册与登录 (6 个接口)
  • 用户 User — 当前登录用户资料与头像 (4 个接口)
  • 画师专辑 Albums — 每个画师自有的专辑/文件夹;一张图纸可加入多个专辑。公开只见 status=1,本人可见隐藏专辑。 (6 个接口)
  • 图纸社区 Patterns — 拼豆图纸列表、详情、搜索、分类与排序(最热 / 最新 / 关注的) (5 个接口)