后台接口

0. 请求地址

暂无

1. 数据格式

请求header
"Content-Type": "application/x-www-form-urlencoded",
"X-token-zaowanda":"",
"X-token-user":""
类型 描述
Content-Type 默认为： application/x-www-form-urlencoded 上传文件时需要修改为：multipart/form-data
X-token-zaowanda 请求后台的接口token，用于验证请求来源及控制次数，自定义后台接口可以不使用该字段
X-token-user 用户登录后申请的后台返回的用户token，该字段也可不用
返回数据

返回数据为json格式

{
    "code":0,
    "message":"",
    "data":object
}

数据说明

参数 类型 必选 描述
code integer 是 数据返回的错误码，详见下表
message string 是 错误码对应描述，详见下表
data object 否 不同的接口返回数据类型不同，具体已接口描述为主。当code不为0时，该字段可能为空

2. 全局错误码

错误码 错误说明
0 处理成功 message为 success
-1 大多错误码，message为包含相应提示
200001 X-token-zaowanda为空
200002 X-token-zaowanda不存在
200003 X-token-zaowanda已过期
200004 X-token-zaowanda请求次数频繁，稍后重试
200005 token请求已超过当天当天最大次数
200007 权限不足，您无权操作此用户
9999100 参数异常，或缺少必填参数

3. 答题管理

3.1 保存或移除错题

请求uri

answer/wrong

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户授权登录后返回的uid
cid integer 是 题库id，选择题库后选择的id
id integer 是 答题的题目id
type integer 是 1- 添加错题 0-移除错题

返回参数

{
    "code":0,
    "message":"",
    "data":1
}

参数说明

参数 类型 必选 描述
data integer 是 1-操作成功 0-操作失败
3.2 添加或者移除收藏

请求uri

answer/favorite

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户授权登录后返回的uid
cid integer 是 题库id，选择题库后选择的id
id integer 是 答题的题目id
type integer 是 1- 收藏题目 0-移除收藏

返回参数

{
    "code":0,
    "message":"",
    "data":1
}

参数说明

参数 类型 必选 描述
data integer 是 1-操作成功 0-操作失败
3.3 判断是否收藏该题

请求uri

answer/isfavorite

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户授权登录后返回的uid
cid integer 是 题库id，选择题库后选择的id
id integer 是 答题的题目id

返回参数

{
    "code":0,
    "message":"",
    "data":1
}

参数说明

参数 类型 必选 描述
data integer 是 1-收藏 0-未收藏
3.4 用户收藏题目数量

请求uri

answer/favoriteCount

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户授权登录后返回的uid
cid integer 是 题库id，选择题库后选择的id

返回参数

{
    "code":0,
    "message":"",
    "data":1
}

参数说明

参数 类型 必选 描述
data integer 是 题库收藏题目数量
3.5 用户答题错题题目数量

请求uri

answer/wrongCount

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户授权登录后返回的uid
cid integer 是 题库id，选择题库后的id

返回参数

{
    "code":0,
    "message":"",
    "data":1
}

参数说明

参数 类型 必选 描述
data integer 是 题库答错题目数量

4. 分类管理

4.1 题库分类

请求uri

category/list

请求方式

Get

请求参数

参数 类型 必选 描述
pid integer 是 上级题库分类id，根分类传值：0

返回参数

{
    "code":0,
    "message":"",
    "data":[
        {
           "id":4,
           "name":"分类名称1",
           "children":[
              {
               "id":4,
               "name":"分类名称1",
               "children":[

               ]
              }         
           ]
        },
        {
           "id":5,
           "name":"分类名称2",
           "children":[

           ]
        }
    ]
}

参数说明

参数 类型 必选 描述
data array 是 分类的数组

data中元素说明:

参数 类型 必选 描述
id integer 是 题目分类id
name string 是 题目分类名称
children array 否 如果分类包含子元素，该值存在。反之不存在，该数组元素跟data中元素一样
4.2 试卷分类

请求uri

category/exam/list

请求方式

Get

请求参数

参数 类型 必选 描述
pid integer 是 上级试卷分类id，根分类传值：0

返回参数

{
    "code":0,
    "message":"",
    "data":[
        {
           "id":4,
           "name":"分类名称1",
           "children":[
              {
               "id":4,
               "name":"分类名称1",
               "children":[

               ]
              }         
           ]
        },
        {
           "id":5,
           "name":"分类名称2",
           "children":[

           ]
        }
    ]
}

参数说明

参数 类型 必选 描述
data array 是 分类的数组

data中元素说明:

参数 类型 必选 描述
id integer 是 试卷分类id
name string 是 试卷分类名称
children array 否 如果分类包含子元素，该值存在。反之不存在，该数组元素跟data中元素一样

5.试卷管理

5.1 模拟考试提交答案

请求uri

exam/submit

请求方式

Post

请求参数

参数 类型 必选 描述
cid integer 是 题库分类id
uid integer 是 用户id
right integer 是 答对得分
wrong integer 是 错题个数

返回参数

{
    "code":0,
    "message":"",
    "data":1
}

参数说明

参数 类型 必选 描述
data integer 是 1-操作成功, 0-操作失败
5.2 模拟考试排名

请求uri

exam/rank

请求方式

Post

请求参数

参数 类型 必选 描述
cid integer 是 题库分类id

返回参数

{
    "code":0,
    "message":"",
    "data":[
        {
            "nickName":"昵称",
            "score":30,
            "avatarUrl":"http://safsff.png",
            "createTime":"模拟考试时间"
        }
    ]
}

参数说明

参数 类型 必选 描述
data array 是 数组列表

data元素数据说明

参数 类型 必选 描述
nickName string 是 昵称
score integer 是 得分
avatarUrl string 是 头像地址
createTime string 是 考试时间格式为: yyyy-MM-dd HH:mm:ss
5.3 搜索试卷

请求uri

exam/search

请求方式

Post

请求参数

参数 类型 必选 描述
pid integer 否 试卷分类id
examName string 否 试卷名称
version string 否 试卷版本
fileType string 否 试卷文件类型
page integer 否 页码默认为:0
size integer 否 页容量默认为:10

返回参数

{
    "code": 0,
    "data": {
        "list": [
            {
                "examName": "徐州市2019年七年级语文上册期末试卷",
                "fileSize": "277.5KB",
                "fileType": ".doc",
                "id": 161,
                "version": "人教版"
            } 
        ],
        "page": 0,
        "size": 10,
        "totalPages": 23,
        "totalSize": 228
    },
    "message": "success"
}

参数说明

参数 类型 必选 描述
page integer 是 当前页码
size integer 是 页容量
totalPages integer 是 总页码
totalSize integer 是 元素总容量
list array 是 元素集合

list元素数据说明

参数 类型 必选 描述
id integer 是 试卷主键
fileType string 是 文件类型
fileSize string 是 文件大小
version string 是 试卷版本
examName string 是 试卷名称
5.4 获取导出试卷消耗积分信息

请求uri

exam/info

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户id

返回参数

{
    "code":0,
    "message":"",
    "data":{
       "needIntegral":100,
       "integral":12 
    }
}

参数说明

参数 类型 必选 描述
needIntegral integer 是 导出试卷所需积分
integral integer 是 用户剩余积分

6. 导出管理

6.1 获取导出题库消耗积分信息

请求uri

export/info

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户id
cid integer 是 导出题库分类id

返回参数

{
    "code":0,
    "message":"",
    "data":{
       "count":100,
       "integral":12 
    }
}

参数说明

参数 类型 必选 描述
count integer 是 导出题库数量，1题1积分，相当于导出所需积分
integral integer 是 用户剩余积分
6.2 导出题库

请求uri

export/

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户id
cid integer 是 导出题库分类id
email string 是 导出邮箱

返回参数

{
    "code":0,
    "message":"",
    "data":3
}

参数说明

参数 类型 必选 描述
data integer 是 导出成功后用户所剩积分
6.3 导出试卷

请求uri

export/exam

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户id
eid integer 是 导出试卷id
email string 是 导出邮箱

返回参数

{
    "code":0,
    "message":"",
    "data":3
}

参数说明

参数 类型 必选 描述
data integer 是 导出成功后用户所剩积分

7. 通知管理

7.1 获取用户消息通知

请求uri

notify/info

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 否 用户id，为空时，返回系统通知消息

返回参数

{
    "code":0,
    "message":"",
    "data":{
        "message":"通知内容",
        "title":"标题",
        "stopService":1,
        "id":1,
        "forbidden":false
    }
}

参数说明

参数 类型 必选 描述
data integer 否 为空时表示无通知

data 元素说明

参数 类型 必选 描述
message string 是 通知内容
title string 是 通知标题
stopService integer 是 系统是否停止服务 1-yes 0-no
id integer 是 通知id
forbidden boolean 是 账户已封禁

8. pdf 管理

8.1 获取pdf处理信息

请求uri

pdf/info

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户id

返回参数

{
    "code":0,
    "message":"",
    "data":{
       "count":100,
       "integral":12,
       "freeCount":1,
       "needIntegral":100
    }
}

参数说明

参数 类型 必选 描述
count integer 是 当天已处理pdf文件数量
integral integer 是 用户剩余积分
freeCount integer 是 系统设置免费处理pdf文档次数
needIntegral integer 是 免费处理次数消耗完毕后继续处理所需消耗积分
8.2 加密pdf文件信息

请求uri

pdf/encrypt

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户id
password string 是 加密密钥
file file 是 上传pdf文件文件大小限制100m
readonly integer 是 是否只读 1-是, 0-否
type integer 是 类型1-消耗免费次数，2-消耗积分
email string 是 发送邮箱，文件处理完成已邮件形式发回
fileName string 否 文件名称，为空后台使用源文件名称

返回参数

{
    "code":0,
    "message":"",
    "data":{
       "domain":"http://",
       "path":"dfasd/dsfa.pdf",
       "count":1,
       "integral":100
    }
}

参数说明

参数 类型 必选 描述
domain string 是 下载pdf域名
path string 是 下载pdf路径
count integer 是 当日处理pdf文档次数
integral integer 是 用户剩余积分
8.3 解密pdf文件信息

请求uri

pdf/decrypt

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户id
file file 是 上传pdf文件文件大小限制100m
type integer 是 类型1-消耗免费次数，2-消耗积分
email string 是 发送邮箱，文件处理完成已邮件形式发回
fileName string 否 文件名称，为空后台使用源文件名称

返回参数

{
    "code":0,
    "message":"",
    "data":{
       "domain":"http://",
       "path":"dfasd/dsfa.pdf",
       "count":1,
       "integral":100
    }
}

参数说明

参数 类型 必选 描述
domain string 是 下载pdf域名
path string 是 下载pdf路径
count integer 是 当日处理pdf文档次数
integral integer 是 用户剩余积分
8.4 pdf文件加水印

请求uri

pdf/watermark

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户id
file file 是 上传pdf文件文件大小限制100m
type integer 是 类型1-消耗免费次数，2-消耗积分
email string 是 发送邮箱，文件处理完成已邮件形式发回
watermark string 是 水印内容
fileName string 否 文件名称，为空后台使用源文件名称

返回参数

{
    "code":0,
    "message":"",
    "data":{
       "domain":"http://",
       "path":"dfasd/dsfa.pdf",
       "count":1,
       "integral":100
    }
}

参数说明

参数 类型 必选 描述
domain string 是 下载pdf域名
path string 是 下载pdf路径
count integer 是 当日处理pdf文档次数
integral integer 是 用户剩余积分

9. 题目管理

9.1 获取题库下题目

请求uri

question/list

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户id
type integer 是 类型 1-答题 2-错题 3-收藏 4-模拟考试 5-分享题目
cid integer 否 题库分类id， type为1、2、3、4 时必传
qid integer 否 问题id，type为5时必传

返回参数

{
    "code": 0,
    "data": [
                {
                    "analysis": "",
                    "id": 335,
                    "multiply": 0,
                    "question": "[单选]下列哪一个名称的由来与伍子胥有关？",
                    "rightAnswer": "B",
                    "selectList": [
                        {
                        "title": "A、月老"
                        },
                        {
                        "title": "B、千金小姐"
                        },
                        {
                        "title": "C、新郎"
                        },
                        {
                        "title": "D、岳父"
                        }
                        ],
                    "type": 1
                }
            ],
    "message": "success"
}

参数说明

参数 类型 必选 描述
data array 是 获取题库中的题目列表

data中元素说明

参数 类型 必选 描述
analysis string 是 题目解析
id integer 是 题目id
multiply integer 是 是否多选题 1-是，0-否
question string 是 题目
rightAnswer string 是 正确答案
selectList array 是 选项列表
type integer 是 题目类型 1-选择题, 2-简答 3-判断

selectList中元素说明

参数 类型 必选 描述
title string 是 题目选项内容
9.2 查询题库题目数量

请求uri

question/count

请求方式

Post

请求参数

参数 类型 必选 描述
cid integer 是 题库分类id

返回参数

{
    "code":0,
    "message":"",
    "data":3
}

参数说明

参数 类型 必选 描述
data integer 是 查询题库中题目数量
9.3 题目纠错

请求uri

question/correct

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户id
cid integer 是 题库分类id
qid integer 是 题目id
reason string 是 纠错原因

返回参数

{
    "code":0,
    "message":"",
    "data":"提交成功，审核通过后您将获得积分奖励喔!"
}

参数说明

参数 类型 必选 描述
data string 是 操作提示
9.4 题目搜索

请求uri

question/search

请求方式

Post

请求参数

参数 类型 必选 描述
keywords string 是 搜错关键词
cid integer 是 题库分类id
page integer 否 页码，默认0
size integer 否 页容量，默认10

返回参数

{
    "code": 0,
    "data": {
        "list": [
            {
                "id": 353,
                "question": "[单选]下面有关佛教故事的画卷是"
            }

        ],
        "page": 0,
        "size": 10,
        "totalPages": 2,
        "totalSize": 20
    },
    "message": "success"
}

参数说明

参数 类型 必选 描述
page integer 是 当前页码
size integer 是 页容量
totalPages integer 是 总页码
totalSize integer 是 元素总容量
list array 是 元素集合

list元素数据说明

参数 类型 必选 描述
id integer 是 题目主键
question string 是 问题
9.5 获取每日一题信息

请求uri

question/today

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户id

返回参数

{
    "code": 0,
    "data": {
        "alreadyAnswer": false,
        "answerIntegral": 0,
        "integral": 20,
        "qid": 243271,
        "questions": [
            {
                "analysis": "内分泌腺无导管",
                "id": 243271,
                "multiply": 0,
                "question": "[单选]有关内分泌腺的特点，哪一项描述，哪一项错误？",
                "rightAnswer": "B",
                "selectList": [
                    {
                        "title": "A．腺细胞排列成团成索或围成滤泡"
                    },
                    {
                        "title": "B．有的滤泡与导管相连"
                    },
                    {
                        "title": "C．腺细胞的分泌物称激素"
                    },
                    {
                        "title": "D．激素作用于靶器官或靶细胞"
                    },
                    {
                        "title": "E．腺细胞间有丰富的毛细血管"
                    }
                ],
                "type": 1
            }
        ],
        "totalCount": 99754
    },
    "message": "success"
}

参数说明

参数 类型 必选 描述
alreadyAnswer boolean 是 今日是否已经答题，true已经作答
qid integer 是 题目id
answerIntegral integer 是 如果已经作答，答题获得积分，答错是0，答对获得相应积分
integral integer 是 今日题目答对可获得积分
totalCount integer 是 题库题目总数量
questions array 是 今日答题题目，数组性质，目前只有一题

questions元素数据说明

参数 类型 必选 描述
analysis string 是 题目解析
id integer 是 题目id
multiply integer 是 是否多选题 1-是，0-否
question string 是 题目
rightAnswer string 是 正确答案
selectList array 是 选项列表
type integer 是 题目类型 1-选择题, 2-简答 3-判断

selectList中元素说明

参数 类型 必选 描述
title string 是 题目选项内容
9.6 每日一题答题

请求uri

question/today/answer

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户id
userAnswer string 是 用户答案 多选用英文,分割，如A,B

返回参数

{
    "code": 0,
    "data":"",
    "message": "success"
}

参数说明

参数 类型 必选 描述
data string 是 操作成功会返回数字，为答题获得积分，如0或20。操作失败，会返回中文提示

10. 系统设置管理

10.1 获取邀请赠送积分

请求uri

setting/invite

请求方式

Get

请求参数

参数 类型 必选 描述

返回参数

{
    "code": 0,
    "data":200,
    "message": "success"
}

参数说明

参数 类型 必选 描述
data integer 是 系统设置邀请赠送的积分数量
10.2 获取系统设置的qq交流群号

请求uri

setting/qqgroup

请求方式

Get

请求参数

参数 类型 必选 描述

返回参数

{
    "code": 0,
    "data":"1231",
    "message": "success"
}

参数说明

参数 类型 必选 描述
data integer 是 qq交流群号
10.3 系统初始化

请求uri

init

请求方式

Get

请求参数

参数 类型 必选 描述
uid integer 否 用户id，可有可无

返回参数

{
    "code": 0,
    "data":{
        "category":3
    },
    "message": "success"
}

参数说明

参数 类型 必选 描述
category integer 是 当前题库分类版本号，客户端缓存的值小于该值时，请求题库分类接口并缓存该值

11. 用户管理

11.1 微信用户认证

请求uri

/v2/user/login/{appId}

请求方式

Post

请求参数

参数 类型 必选 描述
appId string 是 路径参数，小程序appId
code string 是 小程序login后获取的code
inviteUid integer 否 邀请人的用户id

返回参数

{
    "code": 0,
    "data":{
        "userId":3,
        "token":"asdfasf-asdfasf-asdfa"
    },
    "message": "success"
}

参数说明

参数 类型 必选 描述
userId integer 是 用户id，客户端缓存需要时传递后台
token string 是 用户token，全局header X-token-user的值
11.2 更新用户信息

请求uri

user/updateUser

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户id
nickName string 否 昵称
gender integer 否 性别
language string 否 语言
city integer 否 城市
province string 否 省份
country integer 否 国家
avatarUrl integer 否 头像

返回参数

{
    "code": 0,
    "data":1,
    "message": "success"
}

参数说明

参数 类型 必选 描述
data integer 是 1-操作成功 0-操作失败
11.3 用户每日签到

请求uri

user/signin

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户id

返回参数

{
    "code": 0,
    "data":"1,23,2",
    "message": "success"
}

参数说明

参数 类型 必选 描述
data string 是 字符串数据格式: 签到获得积分,总签到天数,连续签到天数
11.4 用户当月签到信息

请求uri

user/signin/info

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户id

返回参数

{
    "code": 0,
    "data": {
        "continuousSign": 1,
        "dayIntegral": {
            "2022-06-10": 1,
            "2022-06-24": 1
        },
        "startTime": "2022-06-01",
        "today": "2022-06-24",
        "totalSign": 19
    },
    "message": "success"
}

参数说明

参数 类型 必选 描述
continuousSign integer 是 连续签到天数
dayIntegral map 是 当月签到信息，key为日期，value是当天签到获得积分
startTime string 是 当月起始日期 yyyy-MM-dd
today string 是 当日 yyyy-MM-dd
totalSign integer 是 总签到天数
11.5 用户总积分数量

请求uri

user/integral

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户id

返回参数

{
    "code": 0,
    "data": 123,
    "message": "success"
}

参数说明

参数 类型 必选 描述
data integer 是 用户总积分数量
11.6 用户积分log

请求uri

user/integral/list

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户id
page integer 否 页码默认为:0
size integer 否 页容量默认为:10

返回参数

{
    "code": 0,
    "data": [
        {
            "afterCount": 89,
            "beforeCount": 88,
            "createTime": "2022-06-24 09:37:25",
            "integral": 1,
            "remark": "签到",
            "type": 1
        },
        {
            "afterCount": 87,
            "beforeCount": 187,
            "createTime": "2022-05-21 11:56:32",
            "integral": 100,
            "remark": "处理pdf",
            "type": 2
        }
    ],
    "message": "success"
}

参数说明

参数 类型 必选 描述
data array 是 数组列表

data元素说明

参数 类型 必选 描述
afterCount integer 是 积分操作后数量
beforeCount integer 是 积分操作前数量
createTime string 是 记录日期
integral integer 是 操作积分
remark string 是 备注
type integer 是 1-增加 2-减少
11.7 用户邀请用户信息

请求uri

user/invite/list

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户id
page integer 否 页码默认为:0
size integer 否 页容量默认为:10

返回参数

{
    "code": 0,
    "data": [
        {
            "nickName": "",
            "createTime": "2022-06-24 09:37:25",
            "integral": 1,

        },
        {
            "nickName": "",
            "createTime": "2022-05-21 11:56:32",
            "integral": 100,

        }
    ],
    "message": "success"
}

参数说明

参数 类型 必选 描述
data array 是 数组列表

data元素说明

参数 类型 必选 描述
nickName string 是 昵称
createTime string 是 记录日期
integral integer 是 邀请获得积分
11.8 用户当天抽奖信息

请求uri

user/integral/wheel

请求方式

Get

请求参数

参数 类型 必选 描述
uid integer 是 用户id

返回参数

{
    "code": 0,
    "data": {
        "alreadyWheel": false,
        "integral": 0,
        "lotteryInfo": [
            {
                "integral": 100,
                "name": "奖项1",
                "remark": "中奖概率1%"
            },
            {
                "integral": 50,
                "name": "奖项2",
                "remark": "中奖概率3%"
            },
            {
                "integral": 30,
                "name": "奖项3",
                "remark": "中奖概率5%"
            },
            {
                "integral": 20,
                "name": "奖项4",
                "remark": "中奖概率7%"
            },
            {
                "integral": 10,
                "name": "奖项5",
                "remark": "中奖概率30%"
            }
        ]
    },
    "message": "success"
}

参数说明

参数 类型 必选 描述
data object 是

data元素说明

参数 类型 必选 描述
alreadyWheel boolean 是 当天是否已经抽奖,true-已抽奖,false-未抽奖
integral integer 是 已抽奖时，为抽奖获得积分
lotteryInfo array 是 奖项设置信息

lotteryInfo元素说明

参数 类型 必选 描述
integral integer 是 奖项积分
name string 是 奖项名称
remark string 是 奖项备注
11.9 用户当天抽奖

请求uri

user/integral/wheel

请求方式

Post

请求参数

参数 类型 必选 描述
uid integer 是 用户id

返回参数

{
    "code": 0,
    "data": {
        "alreadyWheel": false,
        "index": 3,
        "integral": 50,
        "message": "恭喜中奖，获得积分+50"
    },
    "message": "success"
}

参数说明

data元素说明

参数 类型 必选 描述
alreadyWheel boolean 是 当天是否已经抽奖,true-已抽奖,false-未抽奖
index integer 是 抽奖后台返回中奖下标
integral integer 是 抽奖获得积分
message string 是 提示信息

results matching ""

    No results matching ""