Skip to content
页面梗概

助力生态可持续发展

赞助 Fresns 发展

成为赞助者

API 总览

全局配置

请求方式接口路径描述
GET/api/v2/global/configs全局配置信息
GET/api/v2/global/{type}/archives扩展档案配置
GET/api/v2/global/upload-token上传用的令牌
GET/api/v2/global/roles用户角色
GET/api/v2/global/maps地图服务商
GET/api/v2/global/content-type内容类型
GET/api/v2/global/stickers表情图
GET/api/v2/global/block-words阻止词

公共业务

请求方式接口路径描述
GET/api/v2/common/input-tips输入提示信息
POST/api/v2/common/send-verify-code发送验证码
POST/api/v2/common/upload-log上传日志
POST/api/v2/common/upload-file上传文件
GET/api/v2/common/file/{fid}/download-link文件下载链接
GET/api/v2/common/file/{fid}/users下载过文件的用户

账号

请求方式接口路径描述
POST/api/v2/account/register注册
POST/api/v2/account/login登录
PUT/api/v2/account/reset-password重置密码
GET/api/v2/account/detail获取账号详情
GET/api/v2/account/wallet-logs钱包交易记录
POST/api/v2/account/verify-identity身份验证
PUT/api/v2/account/edit修改账号资料
DELETE/api/v2/account/logout退出登录
POST/api/v2/account/apply-delete申请删除账号
POST/api/v2/account/revoke-delete撤销删除申请

用户

请求方式接口路径描述
GET/api/v2/user/list获取用户列表
GET/api/v2/user/{uidOrUsername}/detail获取用户详情
GET/api/v2/user/{uidOrUsername}/interactive/{type}获取用户互动的用户列表
GET/api/v2/user/{uidOrUsername}/mark/{markType}/{listType}获取用户标记的内容列表
POST/api/v2/user/auth用户登录
GET/api/v2/user/panel用户面板
PUT/api/v2/user/edit修改用户资料
POST/api/v2/user/mark操作标记
PUT/api/v2/user/mark-note标记备注

消息

请求方式接口路径描述
GET/api/v2/notify/list[通知]获取消息列表
PUT/api/v2/notify/mark-as-read[通知]更新阅读状态
DELETE/api/v2/notify/delete[通知]删除消息
GET/api/v2/dialog/list[会话]获取会话列表
GET/api/v2/dialog/{dialogId}/detail[会话]获取会话详情
GET/api/v2/dialog/{dialogId}/messages[会话]获取消息列表
PUT/api/v2/dialog/mark-as-read[会话]更新阅读状态
POST/api/v2/dialog/send-message[会话]发送消息
DELETE/api/v2/dialog/delete[会话]删除会话或会话的消息

小组

请求方式接口路径描述
GET/api/v2/group/tree获取树结构小组列表
GET/api/v2/group/categories获取小组分类
GET/api/v2/group/list获取小组列表
GET/api/v2/group/{gid}/detail获取小组详情
GET/api/v2/group/{gid}/interactive/{type}获取小组互动的用户列表

话题

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

帖子

请求方式接口路径描述
GET/api/v2/post/list获取帖子列表
GET/api/v2/post/follow/{type}获取关注对象的帖子列表
GET/api/v2/post/nearby获取位置附近的帖子列表
GET/api/v2/post/{pid}/detail获取帖子详情
GET/api/v2/post/{pid}/interactive/{type}获取帖子互动的用户列表
GET/api/v2/post/{pid}/user-list获取帖子的附属用户列表
GET/api/v2/post/{pid}/logs获取帖子的日志列表
GET/api/v2/post/{pid}/log/{logId}获取帖子日志详情
DELETE/api/v2/post/{pid}删除帖子

评论

请求方式接口路径描述
GET/api/v2/comment/list获取评论列表
GET/api/v2/comment/follow/{type}获取关注对象的评论列表
GET/api/v2/comment/{cid}/detail获取评论详情
GET/api/v2/comment/{cid}/interactive/{type}获取评论互动的用户列表
GET/api/v2/comment/{cid}/logs获取评论的日志列表
GET/api/v2/comment/{cid}/log/{logId}获取评论日志详情
DELETE/api/v2/comment/{pid}删除评论

编辑器

请求方式接口路径描述
POST/api/v2/editor/direct-publish直接发表
GET/api/v2/editor/{type}/config编辑器配置信息
GET/api/v2/editor/{type}/drafts获取草稿列表
POST/api/v2/editor/{type}/create创建草稿
POST/api/v2/editor/{type}/generate/{fsid}生成编辑草稿
GET/api/v2/editor/{type}/{draftId}获取草稿详情
PUT/api/v2/editor/{type}/{draftId}更新草稿内容
POST/api/v2/editor/{type}/{draftId}提交发表(或审核)
PATCH/api/v2/editor/{type}/{draftId}撤回审核中草稿
DELETE/api/v2/editor/{type}/{draftId}删除草稿

搜索

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