Skip to content

API 总览

全局配置

请求方式接口路径描述
GET/status.json
/api/fresns/v1/global/status
客户端状态
GET/api/fresns/v1/global/configs配置信息
GET/api/fresns/v1/global/language-pack语言包信息
GET/api/fresns/v1/global/channels扩展频道
GET/api/fresns/v1/global/{type}/archives扩展档案配置
GET/api/fresns/v1/global/{type}/content-types内容类型
GET/api/fresns/v1/global/roles用户角色
GET/api/fresns/v1/global/stickers表情图

公共业务

请求方式接口路径描述
GET/api/fresns/v1/common/ip-infoIP 信息
GET/api/fresns/v1/common/input-tips输入提示信息
GET/api/fresns/v1/common/callback回调返参查询
POST/api/fresns/v1/common/cmd-word命令字请求
GET/api/fresns/v1/common/file/storage-token文件: 存储桶令牌
POST/api/fresns/v1/common/file/uploads文件: 上传文件
PATCH/api/fresns/v1/common/file/{fid}/warning文件: 更新文件警告
GET/api/fresns/v1/common/file/{fid}/link文件: 下载链接
GET/api/fresns/v1/common/file/{fid}/users文件: 下载过文件的用户

账号

请求方式接口路径描述
POST/api/fresns/v1/account/auth-token账号登录
DELETE/api/fresns/v1/account/auth-token退出登录
GET/api/fresns/v1/account/detail获取账号详情
GET/api/fresns/v1/account/wallet-records钱包交易记录

用户

功能

请求方式接口路径描述
POST/api/fresns/v1/user/auth-token用户登录
GET/api/fresns/v1/user/overview用户概览
GET/api/fresns/v1/user/extcredits-records用户扩展分值记录
PATCH/api/fresns/v1/user/profile修改用户资料
PATCH/api/fresns/v1/user/device-token更新设备凭证
POST/api/fresns/v1/user/mark操作标记
PATCH/api/fresns/v1/user/mark-note标记备注
POST/api/fresns/v1/user/extend-action操作扩展交互

互动

请求方式接口路径描述
GET/api/fresns/v1/user/list获取用户列表
GET/api/fresns/v1/user/{uidOrUsername}/detail获取用户详情
GET/api/fresns/v1/user/{uidOrUsername}/followers-you-follow获取用户认识的关注者
GET/api/fresns/v1/user/{uidOrUsername}/interaction/{type}获取用户互动的用户列表
GET/api/fresns/v1/user/{uidOrUsername}/mark/{markType}/{listType}获取用户标记的内容列表

消息

通知

请求方式接口路径描述
GET/api/fresns/v1/notification/list获取消息列表
PATCH/api/fresns/v1/notification/read-status更新阅读状态
DELETE/api/fresns/v1/notification/messages删除消息

对话

请求方式接口路径描述
GET/api/fresns/v1/conversation/list获取对话列表
GET/api/fresns/v1/conversation/{uidOrUsername}/detail获取对话详情
GET/api/fresns/v1/conversation/{uidOrUsername}/messages获取消息列表
PATCH/api/fresns/v1/conversation/{uidOrUsername}/pin置顶对话
PATCH/api/fresns/v1/conversation/{uidOrUsername}/read-status更新阅读状态
DELETE/api/fresns/v1/conversation/{uidOrUsername}删除对话或消息
POST/api/fresns/v1/conversation/message发送消息

小组

请求方式接口路径描述
GET/api/fresns/v1/group/tree获取树结构小组列表
GET/api/fresns/v1/group/list获取小组列表
GET/api/fresns/v1/group/{gid}/detail获取小组详情
GET/api/fresns/v1/group/{gid}/creator获取小组创建者
GET/api/fresns/v1/group/{gid}/admins获取小组管理员
GET/api/fresns/v1/group/{gid}/interaction/{type}获取小组互动的用户列表

话题

请求方式接口路径描述
GET/api/fresns/v1/hashtag/list获取话题列表
GET/api/fresns/v1/hashtag/{htid}/detail获取话题详情
GET/api/fresns/v1/hashtag/{htid}/interaction/{type}获取话题互动的用户列表

地理

请求方式接口路径描述
GET/api/fresns/v1/geotag/list获取地理列表
GET/api/fresns/v1/geotag/{gtid}/detail获取地理详情
GET/api/fresns/v1/geotag/{gtid}/interaction/{type}获取地理互动的用户列表

帖子

请求方式接口路径描述
GET/api/fresns/v1/post/list获取帖子列表
GET/api/fresns/v1/post/timelines获取时间线的帖子列表
GET/api/fresns/v1/post/nearby获取附近的帖子列表
GET/api/fresns/v1/post/{pid}/detail获取帖子详情
GET/api/fresns/v1/post/{pid}/interaction/{type}获取帖子互动的用户列表
GET/api/fresns/v1/post/{pid}/users获取帖子的附属用户列表
GET/api/fresns/v1/post/{pid}/quotes获取帖子的引用它的帖子列表
GET/api/fresns/v1/post/{pid}/histories获取帖子的历史列表
GET/api/fresns/v1/post/history/{hpid}/detail获取历史帖子详情
DELETE/api/fresns/v1/post/{pid}删除帖子

评论

请求方式接口路径描述
GET/api/fresns/v1/comment/list获取评论列表
GET/api/fresns/v1/comment/timelines获取时间线的评论列表
GET/api/fresns/v1/comment/nearby获取附近的评论列表
GET/api/fresns/v1/comment/{cid}/detail获取评论详情
GET/api/fresns/v1/comment/{cid}/interaction/{type}获取评论互动的用户列表
GET/api/fresns/v1/comment/{cid}/histories获取评论的历史列表
GET/api/fresns/v1/comment/history/{hcid}/detail获取历史评论详情
DELETE/api/fresns/v1/comment/{cid}删除评论

编辑器

请求方式接口路径描述
GET/api/fresns/v1/editor/{type}/configs编辑器配置信息
POST/api/fresns/v1/editor/{type}/publish直接发表
POST/api/fresns/v1/editor/{type}/edit/{fsid}编辑帖子或评论
GET/api/fresns/v1/editor/{type}/drafts草稿: 列表
POST/api/fresns/v1/editor/{type}/draft草稿: 创建
GET/api/fresns/v1/editor/{type}/draft/{did}草稿: 详情
PATCH/api/fresns/v1/editor/{type}/draft/{did}草稿: 更新
POST/api/fresns/v1/editor/{type}/draft/{did}草稿: 提交发表(或审核)
PUT/api/fresns/v1/editor/{type}/draft/{did}草稿: 撤回审核中草稿
DELETE/api/fresns/v1/editor/{type}/draft/{did}草稿: 删除

搜索

请求方式接口路径描述
GET/api/fresns/v1/search/users用户
GET/api/fresns/v1/search/groups小组
GET/api/fresns/v1/search/hashtags话题
GET/api/fresns/v1/search/geotags地理
GET/api/fresns/v1/search/posts帖子
GET/api/fresns/v1/search/comments评论

Released under the Apache-2.0 License