Happy Next API 是由 Happy Next 服务端提供的 REST API。所有端点的请求和响应体均使用 JSON 格式。

基础 URL

托管服务:
https://api.happy-next.com
自部署: 你的服务器 URL(例如 http://localhost:3005)。

认证

大多数端点需要在 Authorization 请求头中使用 Bearer 令牌进行认证:
Authorization: Bearer <token>
令牌通过认证端点使用加密签名方案获取(无需密码)。

认证工作原理

  1. 在设备上生成 Ed25519 密钥对
  2. 将公钥和签名后的挑战值发送到 POST /v1/auth
  3. 服务端验证签名并返回 JWT 令牌
  4. 在后续所有请求中携带此令牌

请求格式

  • 内容类型:application/json
  • 所有时间戳为 ISO 8601 字符串或 Unix 毫秒时间戳
  • ID 为字符串格式(CUID2)

响应格式

成功响应直接返回数据。错误响应返回包含 error 字段的 JSON 对象:
{
  "error": "Invalid signature"
}
HTTP 状态码在响应头中设置(例如 401、403),而非在响应体中。

常见状态码

状态码含义
200成功
201已创建
400请求错误(参数无效)
401未认证(缺少或无效的令牌)
403禁止访问(权限不足)
404未找到
500服务器错误

加密说明

API 响应中的许多字段包含加密数据(例如消息内容、会话元数据)。这些数据以加密密文形式存储,只能使用会话的加密密钥进行解密。API 返回原始加密值——需要在客户端进行解密。