跳到主要内容

OpenAPI 3.1.0

Older HTTP API

版本 v1

Older 服务端对外 HTTP 接口。除特别说明外,响应为 JSON。 鉴权通过 HTTP-only Cookie `older_auth` 承载会话令牌(详见 spec.md)。 注意:当前多数接口未在服务端强制校验 HTTP 方法,下方声明的方法为「客户端应使用」的语义方法。

接口总数

43

标签分类

10

数据模型

2

服务器

2

Servers

服务器

https://amass.fun生产环境(amass.fun)
http://localhost:8080本地开发(端口以 settings.toml 的 HttpServer 配置为准)

Security

鉴权方式

cookieAuthapiKey · cookie · older_auth
登录后由服务端下发的 HTTP-only 会话 Cookie。
bearerAuthhttp · bearer
仅 /api/v1/search/reindex 使用,校验 Authorization 头中的 API Key。

分析

4 个接口

访问统计与站点信息

用户

9 个接口

注册、登录、邮箱验证与会话

设备

6 个接口

设备列表、信息与控制

笔记本

3 个接口

笔记本文件读取与同步

设置

2 个接口

运行时设置

访问记录

2 个接口

VisitRecord 查询与删除

便签

4 个接口

TickNote 便签

聊天室

2 个接口

聊天室消息

管理

7 个接口

管理员用户审核与开关(要求 role=admin 且 status=approved)

系统

4 个接口

Live2D 静态资源、设备探测与通知回调

Schemas

数据模型

Envelope

通用业务响应信封(部分历史接口直接返回裸数组或扁平对象,见 spec.md)。

object通用业务响应信封(部分历史接口直接返回裸数组或扁平对象,见 spec.md)。
code*integer业务状态码,多数情况下与 HTTP 状态一致。
message*string
dataany业务负载,结构因接口而异。

Error

object
codeinteger
message*string