API 和标签
UJCMS 前台接口(/api/**)的文档,由 13.2.3 版的源码生成,共 175 个接口。接口地址以站点地址为前缀,例如 https:。
- 模板标签:名称形如“栏目列表_ChannelList”的接口对应同名的模板标签(
[@ChannelList]),接口页里附有标签的写法示例。 - 在线调试:接口页右侧的“试一试”把请求发到演示站 https://demo.ujcms.com。
- 版本:标有 标准版及以上 这类字样的接口属于商业版功能,其余接口社区版即可使用。
- OpenAPI 文件:openapi.json,可导入各类接口调试工具。
内容
站点
| 接口 | 请求 | 版本 |
|---|---|---|
| 站点列表_SiteList | GET /api/site | |
| 获取站点缓冲对象 | GET / | |
| 获取当前站点对象 | GET / | |
| 当前页面的语言备选 | GET / | |
| 获取站点缓冲对象,并记录浏览量 | GET / | |
| 站点对象_Site | GET / |
栏目
| 接口 | 请求 | 版本 |
|---|---|---|
| 栏目列表_ChannelList | GET / | |
| 获取栏目统计数据 | GET / | |
| 栏目对象BySlug_Channel | GET / | |
| 获取栏目浏览次数 | GET / | |
| 栏目对象_Channel | GET / |
文章
| 接口 | 请求 | 版本 |
|---|---|---|
| 文章列表_ArticleList | GET / | |
| 获取文章统计数据 | GET / | |
| 专题文章分页_TopicArticlePage | GET / | |
| 踩文章 | POST / | |
| 获取下载参数 | GET / | |
| 下一篇文章_ArticleNext | GET / | |
| 文章分页_ArticlePage | GET / | |
| 上一篇文章_ArticlePrev | GET / | |
| 文章对象BySlug_Article | GET / | |
| 顶文章 | POST / | |
| 获取文章浏览次数 | GET / | |
| 文章对象_Article | GET / | |
| 相关文章_ArticleRelatedList | GET / |
文章全文检索
| 接口 | 请求 | 版本 |
|---|---|---|
| 全文检索文章列表_EsArticleList | GET / | |
| 全文检索文章分页_EsArticlePage | GET / |
文章排行榜
| 接口 | 请求 | 版本 |
|---|---|---|
| 文章排行榜列表_LeaderBoardList | GET / | |
| 文章排行榜分页_LeaderBoardPage | GET / |
Tag
| 接口 | 请求 | 版本 |
|---|---|---|
| Tag列表_TagList | GET /api/tag | |
| Tag分页_TagPage | GET / | |
| 获取Tag对象 | GET / |
专题
| 接口 | 请求 | 版本 |
|---|---|---|
| 专题列表_TopicList | GET /api/topic | 标准版及以上 |
| 专题对象BySlug_Topic | GET / | 标准版及以上 |
| 获取专题浏览次数 | GET / | 标准版及以上 |
| 专题对象_Topic | GET / | 标准版及以上 |
区块
| 接口 | 请求 | 版本 |
|---|---|---|
| 区块列表_BlockList | GET /api/block |
区块项
| 接口 | 请求 | 版本 |
|---|---|---|
| 区块项列表_BlockItemList | GET / |
链接组
| 接口 | 请求 | 版本 |
|---|---|---|
| 链接组列表_LinkGroupList | GET / |
链接
| 接口 | 请求 | 版本 |
|---|---|---|
| 链接列表_LinkList | GET /api/link |
字典
| 接口 | 请求 | 版本 |
|---|---|---|
| 字典列表_DictList | GET /api/dict |
模型
| 接口 | 请求 | 版本 |
|---|---|---|
| 模型列表_ModelList | GET /api/model | |
| 模型对象_Model | GET / |
推荐
| 接口 | 请求 | 版本 |
|---|---|---|
| 猜你喜欢_RecommendList | GET / | 基础版及以上 |
| 猜你喜欢分页_RecommendPage | GET / | 基础版及以上 |
互动
评论
| 接口 | 请求 | 版本 |
|---|---|---|
| 评论列表_CommentList | GET / | |
| 提交评论 | POST / | |
| 我的评论列表_MyCommentList | GET / | |
| 我的评论分页_MyCommentPage | GET / | |
| 评论分页_CommentPage | GET / | |
| 获取评论对象 | GET / | |
| 删除我的评论_MyCommentDelete | DELETE / |
留言
| 接口 | 请求 | 版本 |
|---|---|---|
| 留言列表_MessageBoardList | GET / | |
| 提交留言 | POST / | |
| 留言分页_MessageBoardPage | GET / | |
| 获取留言对象 | GET / |
留言类型
| 接口 | 请求 | 版本 |
|---|---|---|
| 留言类型列表_MessageBoardTypeList | GET / |
投票
| 接口 | 请求 | 版本 |
|---|---|---|
| 投票列表_VoteList | GET /api/vote | |
| 投票 | POST / | |
| 投票分页_VotePage | GET / | |
| 投票对象_Vote | GET / |
调查问卷
| 接口 | 请求 | 版本 |
|---|---|---|
| 调查问卷列表_SurveyList | GET /api/survey | 标准版及以上 |
| 投票 | POST / | 标准版及以上 |
| 调查问卷分页_SurveyPage | GET / | 标准版及以上 |
| 调查问卷对象_Survey | GET / | 标准版及以上 |
表单
| 接口 | 请求 | 版本 |
|---|---|---|
| 表单列表_FormList | GET /api/form | 标准版及以上 |
| 提交表单 | POST /api/form | 标准版及以上 |
| 表单分页_FormPage | GET / | 标准版及以上 |
| 获取表单对象_Form | GET / | 标准版及以上 |
表单类型
| 接口 | 请求 | 版本 |
|---|---|---|
| 表单类型列表_FormTypeList | GET / | 标准版及以上 |
会员投稿
| 接口 | 请求 | 版本 |
|---|---|---|
| 我的投稿列表_ContributeList | GET / | |
| 投稿_ContributeCreate | POST / | |
| 可投稿栏目_ContributeChannels | GET / | |
| 我的投稿分页_ContributePage | GET / | |
| 我的投稿详情_ContributeShow | GET / | |
| 修改投稿_ContributeUpdate | PUT / | |
| 删除投稿_ContributeDelete | DELETE / |
会员
JWT认证
| 接口 | 请求 | 版本 |
|---|---|---|
| 登录 | POST / | |
| 退出 | POST / | |
| 发送双因子登录验证码 | POST / | |
| 校验双因子登录验证码,完成登录 | POST / | |
| 刷新TOKEN | POST / |
注册
| 接口 | 请求 | 版本 |
|---|---|---|
| 用户注册 | POST / |
密码
会员设置
| 接口 | 请求 | 版本 |
|---|---|---|
| 注销账号 | DELETE / | |
| 更新个人头像 | PUT / | |
| 更新邮箱地址 | PUT / | |
| 更新手机号码 | PUT / | |
| 更新个人信息 | PUT / |
用户
通知
| 接口 | 请求 | 版本 |
|---|---|---|
| 通知列表_NotificationList | GET / | |
| 删除通知 | DELETE / | |
| 通知分页_NotificationPage | GET / | |
| 标记通知已读 | PUT / | |
| 清空已读通知 | DELETE / | |
| 标记全部通知已读 | PUT / | |
| 未读通知数量 | GET / |
私信会话
| 接口 | 请求 | 版本 |
|---|---|---|
| 会话列表_ConversationList | GET / | |
| 删除会话 | DELETE / | |
| 会话分页_ConversationPage | GET / | |
| 标记会话已读 | PUT / | |
| 未读私信数量 | GET / |
私信
| 接口 | 请求 | 版本 |
|---|---|---|
| 私信记录分页_MessagePage | GET / | |
| 发送私信 | POST / |
好友
| 接口 | 请求 | 版本 |
|---|---|---|
| 好友列表_FriendList | GET /api/friend | |
| 发起好友申请 | POST / | |
| 解除好友关系 | DELETE / | |
| 通过好友申请 | PUT / | |
| 好友分页_FriendPage | GET / | |
| 收到的好友申请分页 | GET / | |
| 收到的好友申请数量 | GET / | |
| 与指定用户的好友关系 | GET / | |
| 发出的好友申请分页 | GET / |
关注
| 接口 | 请求 | 版本 |
|---|---|---|
| 关注列表_FollowList | GET /api/follow | |
| 关注文章、栏目或用户 | POST / | |
| 取消关注文章、栏目或用户 | DELETE / | |
| 是否已关注文章或栏目 | GET / | |
| 粉丝列表_FollowerList | GET / | |
| 粉丝分页_FollowerPage | GET / | |
| 关注分页_FollowPage | GET / | |
| 与指定用户的关注关系 | GET / | |
| 指定用户的粉丝数和关注数 | GET / |
收藏夹
| 接口 | 请求 | 版本 |
|---|---|---|
| 收藏夹列表_FavoriteGroupList | GET / | |
| 创建收藏夹 | POST / | |
| 修改收藏夹名称 | PUT / | |
| 删除收藏夹 | DELETE / |
收藏
| 接口 | 请求 | 版本 |
|---|---|---|
| 收藏列表_FavoriteList | GET / | |
| 收藏文章 | POST / | |
| 移动收藏至收藏夹 | PUT / | |
| 取消收藏文章 | DELETE / | |
| 是否已收藏文章 | GET / | |
| 收藏分页_FavoritePage | GET / |
浏览历史
| 接口 | 请求 | 版本 |
|---|---|---|
| 浏览历史列表_ViewHistoryList | GET / | |
| 删除单条浏览历史 | DELETE / | |
| 清空浏览历史 | DELETE / | |
| 浏览历史分页_ViewHistoryPage | GET / |
政务
领导信箱
| 接口 | 请求 | 版本 |
|---|---|---|
| 信件选登列表_MailboxList | GET / | 旗舰版 |
| 提交来信 | POST / | 旗舰版 |
| 我的信件 | GET / | 旗舰版 |
| 信件选登分页_MailboxPage | GET / | 旗舰版 |
| 查询办理结果 | GET / | 旗舰版 |
| 满意度评价 | POST / | 旗舰版 |
| 获取选登信件 | GET / | 旗舰版 |
信箱类型
| 接口 | 请求 | 版本 |
|---|---|---|
| 信箱类型列表_MailboxTypeList | GET / | 旗舰版 |
依申请公开
| 接口 | 请求 | 版本 |
|---|---|---|
| 提交申请 | POST / | 旗舰版 |
| 我的申请 | GET / | 旗舰版 |
| 查询办理结果 | GET / | 旗舰版 |
| 提交补正 | POST / | 旗舰版 |
在线访谈
| 接口 | 请求 | 版本 |
|---|---|---|
| 访谈列表_InterviewList | GET / | 旗舰版 |
| 访谈分页_InterviewPage | GET / | 旗舰版 |
| 提交提问 | POST / | 旗舰版 |
| 获取访谈详情 | GET / | 旗舰版 |
| 访谈实录列表 | GET / | 旗舰版 |
| 网友提问列表 | GET / | 旗舰版 |
系统
环境
| 接口 | 请求 | 版本 |
|---|---|---|
| backendState | GET / | |
| clientPublicKey | GET / | |
| config | GET / | |
| currentSiteList | GET / |
验证码
| 接口 | 请求 | 版本 |
|---|---|---|
| 获取验证码题目 | GET / | |
| 是否需要显示验证码 | GET / | |
| 尝试验证码是否正确 | GET / | |
| 当前生效的验证码类型 | GET / |
短信
| 接口 | 请求 | 版本 |
|---|---|---|
| 发送邮件短信 | POST / | |
| 验证邮件短信是否正确 | GET / | |
| 发送手机短信 | POST / | |
| 验证手机短信是否正确 | GET / |
上传
| 接口 | 请求 | 版本 |
|---|---|---|
| 裁剪头像 | POST / | |
| 上传头像 | POST / | |
| contributeImageUpload | POST / | |
| imageUpload | POST / |
访问统计
JSON Schema
| 接口 | 请求 | 版本 |
|---|---|---|
| 已发布的 JSON Schema | GET / |