请求结构
请求方法
支持 HTTP GET 方法发送请求,这种方式下请求参数需要包含在请求的 URL 中。支持 HTTP POST 方法发送请求,这种方式下请求参数需要包含在请求的 BODY 中。
字符编码
请求及返回结果都使用UTF-8字符集进行编码。
公共参数
名称 是否必须
描述
signature 是 签名结果串(参考签名机制)
timestamp 是 系统当前的Unix时间戳
nonce 是 随机数
lang
是 语言信息,目前支持:zh(中文),en(英文),ar(阿拉伯文)
from 是 来源信息,目前支持:android,ios
返回结果
返回的数据格式
调用成功返回的数据格式为: JSON
返回的数据结构
code(状态码)
状态码 描述
0 api不存在
1 操作成功
2 操作失败
3 需要登录
4 需要完善密码
5 需要完善用户信息
6 不需要增加积分
message(相关提示)
以系统返回的提示信息为准
data(数据包)
状态码为0,2,3,4,5,6时,data为“空字符串”
状态码为1时,将返回数据包,若数据不存在,data为”空字符串“
推荐列表
URL /app/v_1_1/article/recommendlist
请求方式
请求参数
名称 是否必填项 描述 返回状态码
id 是 栏目id 状态码 描述
start 是 文章开始位置,默认传0,下次请求时,用本接口返回值 1 操作成功,data为数据包
random 是 随机开始值, 默认传1,下次请求时,用本接口返回值 2 操作失败
point_time 是 节点时间,默认传0,下次请求时,用本接口返回值
token 否 用户身份标识
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'start': '下次请求文章开始位置',
'random': '下次请求随机开始值', 'point_time': '下次请求使用的节点时间', 'more': '是否有更多数据,1有,0没有', 'banner_list': [{//页面顶部banner图列表
'id': '文章id',
'theme': ' 文 章 标 题 ', 'description': '文章描述', 'image_url': '文章预览图',
'is_good': '是否点赞,1已点赞,0未点赞', 'is_collect': '是否收藏,1已收藏,0未收藏',
'link': ' 文 章 链 接 ', 'share_link': '文章分享链接',
},...],
'flash_list': [{//页面中部跑马灯列表(即时列表) 'id': '文章id',
'theme': ' 文 章 标 题 ', 'description': '文章描述',
'is_good': '是否点赞,1已点赞,0未点赞', 'is_collect': '是否收藏,1已收藏,0未收藏', 'link': '文章链接',
'share_link': '文章分享链接',
},...],
'article_list': [{//文章列表'id': '文章id',
'view_type': '视图类型:1左图,2中间大图,3右图,4视频,5即时', 'type': '文章类型:1新闻,2快讯,3图片,4视频,5期刊,6专题', 'column_name': '栏目分类',
'theme': ' 文 章 标 题 ', 'description': '文章描述', 'lead': '导语',
'content': ' 文 章 内 容 ', 'edit_time': '文章发布时间', 'image_url': '文章预览图',
'is_good': '是否点赞,1已点赞,0未点赞', 'is_collect': '是否收藏,1已收藏,0未收藏', 'link': '文章链接',
'share_link': '文章分享链接',
},...],
'flash_id': '即时id'
视频列表
URL /app/v_1_1/article/videolist
请求方式 get
请求参数
名称 是否必填项 描述 返回状态码 描述
start 是 文章开始位置,默认传0,下次请求时,用本接口返回值 1 操作成功,data为数据包
point_time 是 节点时间,默认传0,下次请求时,用本接口返回值 2 操作失败
token 否 用户身份标识
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'start': '下次请求文章开始位置',
'point_time': '下次请求使用的节点时间', 'more': '是否有更多数据,1有,0没有', 'list': [{//文章列表
'id': '文章id',
'view_type': '视图类型:1左图,2中间大图,3右图,4视频,5即时', 'type': '文章类型:1新闻,2快讯,3图片,4视频,5期刊,6专题', 'column_name': '栏目分类',
'theme': ' 文 章 标 题 ', 'description': '文章描述', 'lead': '导语',
'video_is_sans_href': '视频是否为外链,1是外链,0不是外链', 'video_url': '视频链接地址',
'image_url': '视频封面图',
'is_good': '是否点赞,1已点赞,0未点赞', 'is_collect': '是否收藏,1已收藏,0未收藏', 'link': '文章链接',
'share_link': '文章分享链接',
},...]
}
}
专题列表
URL /app/v_1_1/article/speciallist
请求方式 get
请求参数
名称 是否必填项 描述 返回状态码 描述
start 是 文章开始位置,默认传0,下次请求时,用本接口返回值 1 操作成功,data为数据包
point_time 是 节点时间,默认传0,下次请求时,用本接口返回值 2 操作失败
token 否 用户身份标识
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'start': '下次请求文章开始位置',
'point_time': '下次请求使用的节点时间', 'more': '是否有更多数据,1有,0没有', 'banner_list': [{//页面顶部banner图列表
'id': '文章id',
'theme': ' 文 章 标 题 ', 'description': '文章描述', 'image_url': '文章预览图',
'is_good': '是否点赞,1已点赞,0未点赞', 'is_collect': '是否收藏,1已收藏,0未收藏', 'link': '文章链接',
'share_link': '文章分享链接',
},...],
'list': [{//文章列表
'id': '文章id',
'view_type': '视图类型:1左图,2中间大图,3右图,4视频,5即时', 'type': '文章类型:1新闻,2快讯,3图片,4视频,5期刊,6专题', 'column_name': '栏目分类',
'theme': ' 文 章 标 题 ', 'description': '文章描述', 'lead': ' 导 语 ', 'image_url': '文章预览图',
'is_good': '是否点赞,1已点赞,0未点赞', 'is_collect': '是否收藏,1已收藏,0未收藏', 'link': '文章链接',
'share_link': '文章分享链接',
},...]
搜索页列表
URL /app/v_1_1/article/search
请求方式 get
请求参数
名称 是否必填项 描述 返回状态码 描述
start 是 文章开始位置,默认传0,下次请求时,用本接口返回值 1 操作成功,data为数据包
point_time 是 节点时间,默认传0,下次请求时,用本接口返回值 2 操作失败
keywords 否 搜索关键字
token 否 用户身份标识
返回值
{
'code': '1',
'message': '成功提示', 'data': {
'start': '下次请求文章开始位置',
'point_time': '下次请求使用的节点时间', 'keywords': '搜索的关键字',
'more': '是否有更多数据,1有,0没有', 'list': [{//文章列表
'id': '文章id',
'view_type': '视图类型:1左图,2中间大图,3右图,4视频,5即时', 'type': '文章类型:1新闻,2快讯,3图片,4视频,5期刊,6专题', 'column_name': '栏目分类',
'theme': '文章标题',
'description': '文章描述', 'content': ' 文 章 内 容 ', 'edit_time': '文章发布时间',
'is_good': '是否点赞,1已点赞,0未点赞', 'is_collect': '是否收藏,1已收藏,0未收藏', 'link': '文章链接',
'share_link': '文章分享链接',
'image_url': '文章预览图(系统会根据不同视图类型,返回不同大小的图片)',
},...]
用户对文章进行点赞,点踩
URL /api/article/userevaluate
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
id 是 文章id 1 操作成功,data为空字符串
type 是 判断是点赞还是点踩,1赞,2踩 2 操作失败
token 是 用户身份标识 3 需要登录
返回值
{
'code': '1',
'message': '成功提示',
'data': '',
}
用户收藏和取消收藏文章
URL /api/article/userevaluate
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
id 是 文章id 1 操作成功,data为空字符串
type 是 判断是收藏还是取消收藏,1收藏,2取消收藏 2 操作失败
token 是 用户身份标识 3 需要登录
返回数据
{
'code': '1',
'message': '成功提示',
'data': '',
}
用户阅读文章,增加积分
URL /api/article/readarticleaddintegral
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
id 是 文章id 1 操作成功,data为空字符串
token 否 用户身份标识 2 操作失败
6 不需要增加积分
返回数据
{
'code': '1',
'message': '成功提示',
'data': '',
}
文章详情中,获取跟本文章关联的文章列表
URL /api/article/articleaccess
请求方式 get
请求参数
名称 是否必填项 描述 返回状态码 描述
id 是 文章id 1 操作成功,data为数据包
2 操作失败
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'access_article_list': [{//文章列表
'id': '文章id',
'theme': ' 文 章 标 题 ', 'description': '文章描述',
'type': '文章类型:1新闻,2快讯,3图片,4视频,5期刊,6专题', 'column_name': '栏目分类',
'is_good': '是否点赞,1已点赞,0未点赞', 'is_collect': '是否收藏,1已收藏,0未收藏', 'link': '文章链接',
'share_link': '文章分享链接',
'image_url': '文章预览图(系统会根据不同文章类型,返回不同大小的图片)',
},...],
'type': '文章类型:1新闻,2快讯,3图片,4视频,5期刊,6专题',
}
}
文章是否被用户 点赞,点踩,收藏
URL /api/article/articleattribute
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
id 是 文章id 1 操作成功,data为数据包
token 否 用户身份标识 2 操作失败
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'is_good': '是否被点赞,1是,0否',
'is_diff': '是否被点踩,1是,0否', 'is_collect': '是否被收藏,1是,0否',
}
}
文章删除
URL /api/article/articledelete
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
id 是 文章id 1 操作成功,data为空字符串
token 是 用户身份标识 2 操作失败
3 需要登录
返回数据
{
'code': '1',
'message': '成功提示',
'data': '',
}
栏目列表
URL /api/column/columnlist
请求方式 get
请求参数
名称 是否必填项 描述 返回状态码 描述
token 否 用户身份标识 1 操作成功,data为数据包
2 操作失败
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'list': [{//栏目列表
'id': '栏目id',
'name': ' 栏 目 名 称 ', 'description': '文章描述',
'type': '栏目类型:1用户必须要看到的栏目,2用户可以取消展示的栏目', 'back_color': '栏目背景色',
},...],
}
}
栏目管理列表
URL /api/column/columnmanagelist
请求方式 get
请求参数
名称 是否必填项 描述 返回状态码 描述
token 否 用户身份标识 1 操作成功,data为数据包
2 操作失败
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'list': {
'my_column': [{//用户已选中的栏目列表'id': '栏目id',
'name': ' 栏 目 名 称 ', 'description': '文章描述',
'type': '栏目类型:1用户必须要看到的栏目,2用户可以取消展示的栏目', 'back_color': '栏目背景色',
},...],
'more_column': [{//用户可以选择添加的栏目列表'id': '栏目id',
'name': ' 栏 目 名 称 ', 'description': '文章描述',
'type': '栏目类型:1用户必须要看到的栏目,2用户可以取消展示的栏目', 'back_color': '栏目背景色',
},...],
}
}
}
栏目管理
URL /api/column/columnmanage
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
column_id 是 栏目id,多个栏目id‘用“英文逗号”隔开 1 操作成功,data为空字符串
sort 是 顺序值,多个顺序值用"英文逗号"隔开 2 操作失败
token 是 用户身份标识 3 需要登录
返回数据
{
'code': '1',
'message': '成功提示',
'data': '',
}
文章评论列表
URL /api/comment_reply/commentlist
请求方式 get
请求参数
名称 是否必填项 描述 返回状态码 描述
article_id 是 文章id
start 是 评论开始位置,默认传0,下次请求时,用本接口返回值 1 操作成功,data为数据包
point_time 是 节点时间,默认传0,下次请求时,用本接口返回值 2 操作失败
token 否 用户身份标识
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'start': '下次请求评论列表开始位置',
'point_time': '下次请求使用的节点时间', 'more': '是否有更多数据,1有,0没有', 'comment_list': [{//评论列表
'comment_id': '评论id',
'type': '评论类型,1主评论,2评论的回复',
'reply_id': '回复id',
'user_id': '评论人id',
'content': '评论内容',
'username': '评论人名称',
'head_url': ' 评 论 人 头 像 ', 'time_describe': ' 评 论 时 间 ', 'praise_count_describe': '被点赞数量',
'is_praise': '是否被当前用户点过赞,1点过,0没点过', 'reply_start': '下次请求评论回复列表开始位置', 'reply_more': '评论回复列表是否有更多数据,1有,0没有', 'reply_list': [{//评论回复列表
'reply_id': '回复id',
'type': '评论类型,1主评论,2评论的回复', 'comment_id': '评论id',
'content': '回复内容', 'from_name': '回复人名称', 'to_name': '被回复人名称',
'from_id': '回复人id',
'to_id': '被回复人id',
},...]
},...],
}
}
文章回复列表
URL /api/comment_reply/replylist
请求方式 get
请求参数
名称 是否必填项 描述 返回状态码 描述
article_id 是 文章id 1 操作成功,data为数据包
comment_id 是 评论id 2 操作失败
start 是 回复开始位置,默认传0,下次请求时,用本接口返回值
point_time 是 节点时间,默认传0,下次请求时,用本接口返回值
token 否 用户身份标识
返回值
{
'code': '1',
'message': '成功提示', 'data': {
'start': '下次请求回复列表开始位置',
'point_time': '下次请求使用的节点时间', 'more': '是否有更多数据,1有,0没有', 'reply_list': [{//回复列表
'reply_id': '回复id',
'type': '评论类型,1主评论,2评论的回复', 'comment_id': '评论id',
'content': '回复内容', 'from_name': '回复人名称', 'to_name': '被回复人名称',
'from_id': '回复人id',
'to_id': '被回复人id',
},...],
}
}
用户评论文章
URL /api/comment_reply/usercomment
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
article_id 是 文章id 1 操作成功,data为数据包
content 是 评论内容 2 操作失败
token 是 用户身份标识 3 需要登录
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'comment_id': '评论id',
'type': '评论类型,1主评论,2评论的回复',
'reply_id': '回复id',
'user_id': '评论人id',
'content': '评论内容',
'username': '评论人名称',
'head_url': ' 评 论 人 头 像 ', 'time_describe': ' 评 论 时 间 ', 'praise_count_describe': '被点赞数量',
'is_praise': '是否被当前用户点过赞,1点过,0没点过',
}
}
用户回复文章评论
URL /api/comment_reply/userreply
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
article_id 是 文章id 1 操作成功,data为数据包
comment_id 是 评论id 2 操作失败
content 是 评论内容 3 需要登录
to_id 是 被回复用户id
type 是 回复主评论传1,回复评论的回复传2
reply_id 是 回复主评论传0,回复评论的回复时,传这条回复信息的id
token 是 用户身份标识
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'reply_id': '回复id',
'type': '评论类型,1主评论,2评论的回复', 'comment_id': '评论id',
'content': '回复内容', 'from_name': '回复人名称', 'to_name': '被回复人名称',
'from_id': '回复人id',
'to_id': '被回复人id',
}
}
评论点赞
URL /api/comment_reply/commentpraise
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
comment_id 是 评论id 1 操作成功,data为空字符串
token 是 用户身份标识 2 操作失败
3 需要登录
返回数据
{
'code': '1',
'message': '成功提示',
'data': '',
}
评论删除
URL /api/comment_reply/commentdelete
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
comment_id 是 评论id 1 操作成功,data为空字符串
token 是 用户身份标识 2 操作失败
3 需要登录
返回数据
{
'code': '1',
'message': '成功提示',
'data': '',
}
评论回复删除
URL /api/comment_reply/replydelete
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
reply_id 是 评论回复id 1 操作成功,data为空字符串
token 是 用户身份标识 2 操作失败
3 需要登录
返回数据
{
'code': '1',
'message': '成功提示',
'data': '',
}
APP检查升级
URL /api/user/checkupdate
请求方式 get
请求参数
名称 是否必填项 描述 返回状态码 描述
version 是 版本号(1.0.0) 1 操作成功,data为数据包
2 操作失败
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'is_upgrade': '是否需要升级,1需要,2不需要',
'force_upgrade': '是否需要强制升级,1需要,2不需要', 'upgrade_point': '升级提示',
'version_id': '版本id',
}
}
APP升级
URL /api/file/appupgrade
请求方式 get
请求参数
名称 是否必填项 描述 返回状态码 描述
version_id 是 版本id 1 操作成功,直接触发下载功能
2 操作失败
返回数据
code为1,自动触发下载功能code为2
{
'code': '2',
'message': '错误提示',
'data': '',
}
发送短信验证码
URL /api/sms/sendsms
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
mobile 是 手机号 1 操作成功,data为空字符串
type 是 验证码类型:1注册,2修改密码,3修改手机号,4登录 2 操作失败
返回数据
{
'code': '1',
'message': '成功提示',
'data': '',
}
检查短信验证码是否正确
URL /api/sms/checksmscode
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
mobile 是 手机号 1 操作成功,data为空字符串
sms_code 是 短信验证码 2 操作失败
type 是 验证码类型:1注册,2修改密码,3修改手机号,4登录
返回数据
{
'code': '1',
'message': '成功提示',
'data': '',
}
社交登录
URL /api/user/sociallogin
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
type 是 登录类型:sina新浪,qq扣扣,wechat微信 1 操作成功,data为数据包
openid 是 扣扣,微信中的openid,新浪中的uid 2 操作失败
type 是 昵称 5 需要完善用户信息
head_url 是 头像url
unionid 否 微信中的unionid,只有在微信登录时需要传这个参数
返回值
{
'code': '1',
'message': '成功提示', 'data': {
'token': {//token信息
'value': '用户登录成功之后的身份标识', 'expire_time': 'token过期时间',
},
'user_info': {//用户信息'head_url': '头像',
'nickname': '昵称',
'mobile': '手机号',
'qq_bind': 'qq是否绑定,1绑定,0未绑定', 'qq_openid': ' 扣 扣 的 openid', 'qq_unionid': ' 值 为 空 , 可 以 忽 略 ', 'sina_bind': '新浪是否绑定,1绑定,0未绑定', 'sina_openid': ' 新 浪 的 uid', 'sina_unionid': '值为空,可以忽略',
'wechat_bind': '微信是否绑定,1绑定,0未绑定', 'wechat_openid': ' 微 信 的 openid', 'wechat_unionid': ' 微 信 的 unionid', 'notice_count': ' 未 读 消 息 数 量 ', 'my_integral': '我的积分',
'check_in_status': '签到状态:0未签到,1已签到',
}
}
}
社交注册
URL /api/user/socialregister
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
type 是 注册类型:sina新浪,qq扣扣,wechat微信 1 操作成功,data为数据包
扣扣和新浪微博注册时传这个参数,扣扣里的openid,新浪里的uid 2 操作失败
openid 否 3 需要登录
unionid 否 微信中的unionid,微信注册时要传这个参数
mobile 是 手机号
password 是 密码
affirm_password 是 确认密码
返回值
{
'code': '1',
'message': '成功提示', 'data': {
'token': {//token信息
'value': '用户登录成功之后的身份标识', 'expire_time': 'token过期时间',
},
'user_info': {//用户信息'head_url': '头像',
'nickname': '昵称',
'mobile': '手机号',
'qq_bind': 'qq是否绑定,1绑定,0未绑定', 'qq_openid': ' 扣 扣 的 openid', 'qq_unionid': ' 值 为 空 , 可 以 忽 略 ', 'sina_bind': '新浪是否绑定,1绑定,0未绑定', 'sina_openid': ' 新 浪 的 uid', 'sina_unionid': '值为空,可以忽略',
'wechat_bind': '微信是否绑定,1绑定,0未绑定',
'wechat_openid': '微信的openid',
'wechat_unionid': '微信的unionid', 'notice_count': '未读消息数量', 'my_integral': '我的积分',
'check_in_status': '签到状态:0未签到,1已签到',
}
}
}
社交绑定
URL /api/user/socialbind
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
type 是 绑定类型:sina新浪,qq扣扣,wechat微信 1 操作成功,data为数据包
openid 是 扣扣,微信中的openid,新浪中的uid 2 操作失败
nickname 是 昵称 3 需要登录
head_url 是 头像url
unionid 否 微信中的unionid,只有在微信绑定时需要传这个参数
token 是 用户身份标识
返回值
{
'code': '1',
'message': '成功提示', 'data': {
'type': '本次绑定的类型,sina新浪,qq扣扣,wechat微信'
}
}
解除社交绑定
URL /api/user/socialunbind
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
type 是 解绑类型:sina新浪,qq扣扣,wechat微信 1 操作成功,data为数据包
openid 否 扣扣和新浪微博解绑时传这个参数,扣扣里的openid,新浪里的uid 2 操作失败
unionid 否 微信中的unionid,微信解绑时需要传这个参数
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'type': '本次解绑的类型,sina新浪,qq扣扣,wechat微信'
}
}
获取用户信息
URL /api/user/getuserinfo
请求方式 get
请求参数
名称 是否必填项 描述 返回状态码 描述
token 是 用户身份标识 1 操作成功,data为数据包
2 操作失败
3 需要登录
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'user_info': {//用户信息
'head_url': '头像',
'nickname': '昵称',
'mobile': '手机号',
'qq_bind': 'qq是否绑定,1绑定,0未绑定', 'qq_openid': ' 扣 扣 的 openid', 'qq_unionid': ' 值 为 空 , 可 以 忽 略 ', 'sina_bind': '新浪是否绑定,1绑定,0未绑定', 'sina_openid': ' 新 浪 的 uid', 'sina_unionid': '值为空,可以忽略',
'wechat_bind': '微信是否绑定,1绑定,0未绑定', 'wechat_openid': ' 微 信 的 openid', 'wechat_unionid': ' 微 信 的 unionid', 'notice_count': ' 未 读 消 息 数 量 ', 'my_integral': '我的积分',
'check_in_status': '签到状态:0未签到,1已签到',
}
}
}
手机号或邮箱使用密码登录
URL /api/user/login
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
username 是 手机号或者邮箱 1 操作成功,data为数据包
password 是 密码 2 操作失败
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'token': {//token信息
'value': '用户登录成功之后的身份标识', 'expire_time': 'token过期时间',
},
'user_info': {//用户信息
'head_url': '头像',
'nickname': '昵称',
'mobile': '手机号',
'qq_bind': 'qq是否绑定,1绑定,0未绑定', 'qq_openid': ' 扣 扣 的 openid', 'qq_unionid': ' 值 为 空 , 可 以 忽 略 ', 'sina_bind': '新浪是否绑定,1绑定,0未绑定', 'sina_openid': ' 新 浪 的 uid', 'sina_unionid': '值为空,可以忽略',
'wechat_bind': '微信是否绑定,1绑定,0未绑定', 'wechat_openid': ' 微 信 的 openid', 'wechat_unionid': ' 微 信 的 unionid', 'notice_count': ' 未 读 消 息 数 量 ', 'my_integral': '我的积分',
'check_in_status': '签到状态:0未签到,1已签到',
}
}
}
短信验证码登录
URL /api/user/smslogin
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
mobile 是 手机号 1 操作成功,data为数据包
sms_code 是 短信验证码 2 操作失败
4 需要完善密码
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'token': {//token信息
'value': '用户登录成功之后的身份标识', 'expire_time': 'token过期时间',
},
'user_info': {//用户信息
'head_url': '头像',
'nickname': '昵称',
'mobile': '手机号',
'qq_bind': 'qq是否绑定,1绑定,0未绑定', 'qq_openid': ' 扣 扣 的 openid', 'qq_unionid': ' 值 为 空 , 可 以 忽 略 ', 'sina_bind': '新浪是否绑定,1绑定,0未绑定',
'sina_openid': ' 新 浪 的 uid', 'sina_unionid': ' 值 为 空 , 可 以 忽 略 ', 'wechat_bind': '微信是否绑定,1绑定,0未绑定', 'wechat_openid': ' 微 信 的 openid', 'wechat_unionid': ' 微 信 的 unionid', 'notice_count': ' 未 读 消 息 数 量 ', 'my_integral': '我的积分',
'check_in_status': '签到状态:0未签到,1已签到',
}
}
}
用户注册
URL /api/user/register
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
mobile 是 手机号 1 操作成功,data为数据包
password 是 密码 2 操作失败
affirm_password 是 确认密码 3 需要登录
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'token': {//token信息
'value': '用户登录成功之后的身份标识', 'expire_time': 'token过期时间',
},
'user_info': {//用户信息
'head_url': '头像',
'nickname': '昵称',
'mobile': '手机号',
'qq_bind': 'qq是否绑定,1绑定,0未绑定', 'qq_openid': ' 扣 扣 的 openid', 'qq_unionid': ' 值 为 空 , 可 以 忽 略 ', 'sina_bind': '新浪是否绑定,1绑定,0未绑定', 'sina_openid': ' 新 浪 的 uid', 'sina_unionid': '值为空,可以忽略',
'wechat_bind': '微信是否绑定,1绑定,0未绑定', 'wechat_openid': ' 微 信 的 openid', 'wechat_unionid': ' 微 信 的 unionid', 'notice_count': ' 未 读 消 息 数 量 ', 'my_integral': '我的积分',
'check_in_status': '签到状态:0未签到,1已签到',
}
}
}
修改昵称
URL /api/user/editnickname
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
nickname 是 昵称 1 操作成功,data为数据包
token 是 用户身份标识 2 操作失败
3 需要登录
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'user_info': {//用户信息
'head_url': '头像',
'nickname': '昵称',
'mobile': '手机号',
'qq_bind': 'qq是否绑定,1绑定,0未绑定', 'qq_openid': ' 扣 扣 的 openid', 'qq_unionid': ' 值 为 空 , 可 以 忽 略 ', 'sina_bind': '新浪是否绑定,1绑定,0未绑定', 'sina_openid': ' 新 浪 的 uid', 'sina_unionid': '值为空,可以忽略',
'wechat_bind': '微信是否绑定,1绑定,0未绑定', 'wechat_openid': ' 微 信 的 openid', 'wechat_unionid': ' 微 信 的 unionid', 'notice_count': ' 未 读 消 息 数 量 ', 'my_integral': '我的积分',
'check_in_status': '签到状态:0未签到,1已签到',
}
}
}
修改手机号
URL /api/user/editmobile
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
mobile 是 昵称 1 操作成功,data为数据包
sms_code 是 短信验证码 2 操作失败
token 是 用户身份标识 3 需要登录
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'user_info': {//用户信息
'head_url': '头像',
'nickname': '昵称',
'mobile': '手机号',
'qq_bind': 'qq是否绑定,1绑定,0未绑定', 'qq_openid': ' 扣 扣 的 openid', 'qq_unionid': ' 值 为 空 , 可 以 忽 略 ', 'sina_bind': '新浪是否绑定,1绑定,0未绑定', 'sina_openid': ' 新 浪 的 uid', 'sina_unionid': '值为空,可以忽略',
'wechat_bind': '微信是否绑定,1绑定,0未绑定', 'wechat_openid': ' 微 信 的 openid', 'wechat_unionid': ' 微 信 的 unionid', 'notice_count': ' 未 读 消 息 数 量 ', 'my_integral': '我的积分',
'check_in_status': '签到状态:0未签到,1已签到',
}
}
}
修改邮箱
URL /api/user/editemail
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
email 是 邮箱 1 操作成功,data为数据包
token 是 用户身份标识 2 操作失败
3 需要登录
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'user_info': {//用户信息
'head_url': '头像',
'nickname': '昵称',
'mobile': '手机号',
'qq_bind': 'qq是否绑定,1绑定,0未绑定', 'qq_openid': ' 扣 扣 的 openid', 'qq_unionid': ' 值 为 空 , 可 以 忽 略 ', 'sina_bind': '新浪是否绑定,1绑定,0未绑定', 'sina_openid': ' 新 浪 的 uid', 'sina_unionid': '值为空,可以忽略',
'wechat_bind': '微信是否绑定,1绑定,0未绑定', 'wechat_openid': ' 微 信 的 openid', 'wechat_unionid': ' 微 信 的 unionid', 'notice_count': ' 未 读 消 息 数 量 ', 'my_integral': '我的积分',
'check_in_status': '签到状态:0未签到,1已签到',
}
}
}
修改密码
URL /api/user/editpassword
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
mobile 是 手机号 1 操作成功,data为空字符串
sms_code 是 短信验证码 2 操作失败
password 是 密码 3 需要登录
token 是 用户身份标识
返回数据
{
'code': '1',
'message': '成功提示',
'data': '',
}
忘记密码
URL /app/v_1_1/user/savepassword
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
mobile 是 手机号 1 操作成功,data为空字符串
sms_code 是 短信验证码 2 操作失败
password 是 密码 3 需要登录
返回数据
{
'code': '1',
'message': '成功提示',
'data': '',
}
退出登录
URL /api/user/logout
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
token 是 用户身份标识 1 操作成功,data为空字符串
2 操作失败
3 需要登录
返回数据
{
'code': '1',
'message': '成功提示',
'data': '',
}
上传头像
URL /api/user/uploadhead
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
file 是 上传的头像文件 1 操作成功,data为数据包
token 是 用户身份标识 2 操作失败
3 需要登录
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'user_info': {//用户信息
'head_url': '头像',
'nickname': '昵称',
'mobile': '手机号',
'qq_bind': 'qq是否绑定,1绑定,0未绑定', 'qq_openid': ' 扣 扣 的 openid', 'qq_unionid': ' 值 为 空 , 可 以 忽 略 ', 'sina_bind': '新浪是否绑定,1绑定,0未绑定', 'sina_openid': ' 新 浪 的 uid', 'sina_unionid': '值为空,可以忽略',
'wechat_bind': '微信是否绑定,1绑定,0未绑定', 'wechat_openid': ' 微 信 的 openid', 'wechat_unionid': ' 微 信 的 unionid', 'notice_count': ' 未 读 消 息 数 量 ', 'my_integral': '我的积分',
'check_in_status': '签到状态:0未签到,1已签到',
}
}
}
上传二进制文件头像
URL /api/user/uploadflowhead
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
file 是 上传的头像文件 1 操作成功,data为数据包
token 是 用户身份标识 2 操作失败
3 需要登录
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'user_info': {//用户信息
'head_url': '头像',
'nickname': '昵称',
'mobile': '手机号',
'qq_bind': 'qq是否绑定,1绑定,0未绑定', 'qq_openid': '扣扣的openid',
'qq_unionid': ' 值 为 空 , 可 以 忽 略 ', 'sina_bind': '新浪是否绑定,1绑定,0未绑定', 'sina_openid': ' 新 浪 的 uid', 'sina_unionid': ' 值 为 空 , 可 以 忽 略 ', 'wechat_bind': '微信是否绑定,1绑定,0未绑定', 'wechat_openid': ' 微 信 的 openid', 'wechat_unionid': ' 微 信 的 unionid', 'notice_count': ' 未 读 消 息 数 量 ', 'my_integral': '我的积分',
'check_in_status': '签到状态:0未签到,1已签到',
}
}
}
我的收藏
URL /api/user/collect
请求方式 get
请求参数
名称 是否必填项 描述 返回状态码 描述
type 是 类型:0全部,4视频 1 操作成功,data为数据包
start 是 收藏列表开始位置,默认传0,下次请求时,用本接口返回值 2 操作失败
point_time 是 节点时间,默认传0,下次请求时,用本接口返回值 3 需要登录
token 是 用户身份标识
返回数据
{
'code': '1',
'message': '成功提示',
'data': {
'start': '下次请求收藏列表开始位置', 'point_time': '下次请求使用的节点时间', 'more': '是否有更多数据,1有,0没有', 'list': [{//收藏列表
'collect_id': '收藏id', 'id': '文章id',
'theme': ' 文 章 标 题 ', 'description': '文章描述',
'is_good': '是否点赞,1已点赞,0未点赞', 'is_collect': '是否收藏,1已收藏,0未收藏', 'read_count': '阅读次数',
'image_url': '文章预览图(系统会根据不同文章类型,返回不同大小的图
片)',
'link': ' 文 章 链 接 ', 'share_link': '文章分享链接', 'time': '文章收藏时间',
},...]
}
}
我的消息
URL /api/user/notice
请求方式 get
请求参数
名称 是否必填项 描述 返回状态码 描述
start 是 消息列表开始位置,默认传0,下次请求时,用本接口返回值 1 操作成功,data为数据包
point_time 是 节点时间,默认传0,下次请求时,用本接口返回值 2 操作失败
token 是 用户身份标识 3 需要登录
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'start': '下次请求消息列表开始位置',
'point_time': '下次请求使用的节点时间', 'more': '是否有更多数据,1有,0没有', 'list': [{//消息列表
'id': '消息id',
'content': '消息内容',
'is_read': '是否已读,1已读,0未读',
'time': '发送消息时间',
'notice_status': '消息是否异常,1正常,0异常,异常就不用打开详情页面
了',
},...]
}
}
我的消息详情
URL /api/user/noticedetails
请求方式 get
请求参数
名称 是否必填项 描述 返回状态码 描述
id 是 消息id 1 操作成功,data为数据包
token 是 用户身份标识 2 操作失败
3 需要登录
返回数据 通过from_type分为:1系统通知,2评论被回复通知,3评论被点赞通知,4文章被点赞,5文章被评论
{
'code': '1',
'message': '成功提示', 'data': {
'from_type': '类型:1,系统通知',
'is_read': '是否已读,1已读,0未读',
'content': '消息内容',
'time': '推送时间',
}
}
{
'code': '1',
'message': '成功提示', 'data': {
'from_type': '类型:2,评论被回复通知',
'is_read': '是否已读,1已读,0未读', 'reply_user_head_url': '回复用户头像url', 'reply_user_name': ' 回 复 用 户 名 称 ', 'reply_time': ' 回 复 时 间 ', 'by_reply_user_name': '被回复用户名称', 'reply_content': ' 回 复 内 容 ', 'by_reply_content': '被回复内容',
'reply_type': '回复类型:1回复主评论,2回复主评论下的回复', 'link': '文章链接',
'share_link': ' 文 章 分 享 链 接 ', 'article_image_url': '文章封面图', 'article_theme': ' 文 章 标 题 ', 'article_description': '文章描述', 'article_time': '文章发布时间', 'article_id': '文章id',
'article_is_good': '文章是否被点赞:1点过,0没点过', 'article_is_collect': '文章是否被收藏:1收藏,0没收藏', 'delete_comment_reply_id': '删除回复时的id',
}
}
注意:reply_type为1时,调用/api/comment_reply/commentdelete删除评论,comment_id等 于delete_comment_reply_id
reply_type为2时,调用/api/comment_reply/replydelete删除评论,reply_id等于delete_comment_reply_id
{
'code': '1',
'message': '成功提示',
'data': {
'from_type': '类型:3,评论被点赞通知', 'is_read': '是否已读,1已读,0未读', 'praise_user_head_url': '点赞用户头像url', 'praise_user_name': ' 点 赞 用 户 名 称 ', 'praise_time': ' 点 赞 时 间 ', 'comment_praise_count': '评论点赞数量', 'delete_comment_id': ' 删 除 评 论 id', 'comment_user_name': ' 评 论 用 户 名 称 ', 'comment_content': '评论内容',
'link': ' 文 章 链 接 ', 'share_link': '文章分享链接',
'article_image_url': '文章封面图', 'article_theme': ' 文 章 标 题 ', 'article_description': '文章描述', 'article_time': '文章发布时间', 'article_id': '文章id',
'article_is_good': ' 文 章 是 否 被 点 赞 :1 点 过 ,0 没 点 过 ', 'article_is_collect': '文章是否被收藏:1收藏,0没收藏', 'praise_content': '点赞描述(赞了你的评论.) ps:会根据语言自动切换',
}
}
{
'code': '1',
'message': '成功提示', 'data': {
'from_type': '类型:4,文章被点赞通知',
'is_read': '是否已读,1已读,0未读', 'praise_user_head_url': '点赞用户头像url', 'praise_user_name': ' 点 赞 用 户 名 称 ', 'praise_time': ' 点 赞 时 间 ', 'article_praise_count': '文章点赞数量', 'delete_article_id': ' 删 除 文 章 id', 'link': '文章链接',
'share_link': ' 文 章 分 享 链 接 ', 'article_image_url': '文章封面图', 'article_theme': ' 文 章 标 题 ', 'article_description': '文章描述', 'article_time': '文章发布时间', 'article_id': '文章id',
'article_is_good': ' 文 章 是 否 被 点 赞 :1 点 过 ,0 没 点 过 ', 'article_is_collect': '文章是否被收藏:1收藏,0没收藏', 'praise_content': '点赞描述(赞了你的文章.) ps:会根据语言自动切换',
}
}
{
'code': '1',
'message': '成功提示', 'data': {
'from_type': '类型:5,文章被评论',
'is_read': ' 是 否 已 读 ,1 已 读 ,0 未 读 ', 'comment_user_head_url': '评论用户头像url', 'comment_user_name': ' 评 论 用 户 名 称 ', 'comment_time': ' 评 论 时 间 ', 'comment_content': ' 评 论 内 容 ', 'delete_article_id': '删除文章id',
'link': ' 文 章 链 接 ', 'share_link': '文章分享链接',
'article_image_url': '文章封面图', 'article_theme': ' 文 章 标 题 ', 'article_description': '文章描述', 'article_time': '文章发布时间', 'article_id': '文章id',
'article_is_good': '文章是否被点赞:1点过,0没点过', 'article_is_collect': '文章是否被收藏:1收藏,0没收藏',
}
}
设置极光推送id
URL /api/user/setpushid
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
register_id 是 极光推送注册id 1 操作成功,data为空字符串
token 否 用户身份标识 2 操作失败
返回数据
{
'code': '1',
'message': '成功提示',
'data': '',
}
分享文章增加积分
URL /api/user/sharearticleaddintegral
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
id 是 文章id 1 操作成功,data为空字符串
token 否 用户身份标识 2 操作失败
6 不需要增加积分
返回数据
{
'code': '1',
'message': '成功提示',
'data': '',
}
获取APP应用商店ID
URL /api/user/getappid
请求方式 get
请求参数
名称 是否必填项 描述 返回状态码 描述
无参数 1 操作成功,data为数据包
2 操作失败
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'app_id': 'APP应用商店id',
}
}
每日签到获取积分
URL /app/v_1_1/user/checkinaddintegral
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
token 是 用户身份标识 1 操作成功,data为空字符串
2 操作失败
3 需要登录
不需要增加积分
返回数据
{
'code': '1',
'message': '成功提示',
'data': '',
}
我的积分
URL /app/v_1_1/user/myintegral
请求方式 get
请求参数
名称 是否必填项 描述 返回状态码 描述
token 是 用户身份标识 1 操作成功,data为数据包
2 操作失败
3 需要登录
返回数据
{
'code': '1',
'message': '成功提示', 'data': {
'my_integral': '我的积分总数',
'check_in_status': '今日是否签到,0未签到,1已签到', 'read_article_count': '今日阅读文章的数量', 'share_article_count': '今天分享文章的数量',
}
}
删除收藏记录
URL /app/v_1_1/user/deletecollect
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
id 是 收藏id,多个收藏id‘用“英文逗号”隔开 1 操作成功,data为空字符串
token 是 用户身份标识 2 操作失败
3 需要登录
返回数据
{
'code': '1',
'message': '成功提示',
'data': '',
}
删除消息记录
URL /app/v_1_1/user/deletenotice
请求方式 post
请求参数
名称 是否必填项 描述 返回状态码 描述
id 是 消息id,多个消息id‘用“英文逗号”隔开 1 操作成功,data为空字符串
token 是 用户身份标识 2 操作失败
3 需要登录
返回数据
{
'code': '1',
'message': '成功提示',
'data': '',
}