跳到主要内容

OpenAPI 3.1.0

Older HTTP API

版本 v1

Older 服务端对外 HTTP 接口。除特别说明外,响应为 JSON。 鉴权采用「短寿命访问令牌 `older_auth` + 长寿命刷新令牌 `older_refresh_token`」双 Cookie 模型;访问令牌过期后由 `POST /api/v1/user/refresh` 凭刷新令牌续期(详见 spec.md)。

接口总数

44

标签分类

10

数据模型

9

服务器

2

Servers

服务器

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

Security

鉴权方式

cookieAuthapiKey · cookie · older_auth
登录后下发的 HTTP-only 短寿命访问令牌(Max-Age=900s);过期后须经 /api/v1/user/refresh 续期。
refreshCookieAuthapiKey · cookie · older_refresh_token
登录后下发的 HTTP-only 长寿命刷新令牌(Path=/api/v1/user; Max-Age=2592000s),仅用于 /api/v1/user/refresh 换取新访问令牌。
bearerAuthhttp · bearer
仅 /api/v1/search/reindex 使用,将 Authorization 头中的 API Key 与服务端配置的 Meilisearch ApiKey 做常量时间比较。

分析

5 个接口

访问统计与站点信息

用户

9 个接口

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

设备

6 个接口

设备列表、信息与控制

笔记本

3 个接口

笔记本文件读取与同步

设置

2 个接口

运行时设置

访问记录

2 个接口

VisitRecord 查询与删除

便签

4 个接口

TickNote 便签

聊天室

2 个接口

聊天室消息

管理

7 个接口

管理员接口(要求 role=admin 且 status=approved;鉴权失败统一返回 HTTP 403)

系统

4 个接口

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

Schemas

数据模型

Envelope

通用业务信封。注意 message 非必有(部分成功响应仅含 code 与 data)。

object通用业务信封。注意 message 非必有(部分成功响应仅含 code 与 data)。
code*integer业务状态码,多数情况下与 HTTP 状态一致(如 logout 例外,见 spec.md)。
messagestring
dataany业务负载,结构因接口而异。

Error

object
codeinteger
message*string

Device

设备对象(设备状态仅存于内存)。

object设备对象(设备状态仅存于内存)。
device_idstring
namestring
ip_addressarray<string>
mac_addressstring
osstring
versionstring
last_seen_timeintegerUnix 秒
is_onlineboolean
propertiesobject

AccountSummary

object
idinteger
usernamestring
emailstring
statusstringunverified | pending | approved | rejected
rolestringuser | admin
created_atintegerUnix 秒
reviewed_atinteger
reviewed_byinteger
reject_reasonstring

VisitRecord

object
idinteger
urlstring
visitorUuidstring
lastUserAgentstring
lastViewTimeintegerUnix 秒
pageViewCountinteger

FilterRule

object
typestring
patternstring

ChatMessage

object
idinteger
nicknamestring
emailstring
websitestring
contentstring
created_atintegerUnix 秒

TickNote

object
idinteger
contentstring
created_atintegerUnix 秒

NotebookEntry

object
namestring
pathstring
is_directoryboolean
sizeinteger仅普通文件含此字段