Showing
5 changed files
with
336 additions
and
0 deletions
yjw接口文档/y分享.md
0 → 100644
| 1 | +# 分享相关 | ||
| 2 | + | ||
| 3 | +### 1. 抽奖分享 | ||
| 4 | +api-online.test.boxfish.cn/share/acquire/award?access_token=admin | ||
| 5 | +POST | ||
| 6 | +x-www-form-urlencoded参数: | ||
| 7 | +award_code String 奖品码 | ||
| 8 | +image_name String 图片名字 | ||
| 9 | +title String 小标题 | ||
| 10 | +description String 副标题 | ||
| 11 | +返回: | ||
| 12 | +{ | ||
| 13 | + "gold": 173, | ||
| 14 | + "msg": "success", | ||
| 15 | + "onlineScore": 217, | ||
| 16 | + "url": "http://api-online.test.boxfish.cn/share/wechat/acquire/award/1/86995d7a-4916-4e25-9b9e-85bc38a49f21" | ||
| 17 | +} | ||
| 18 | + | ||
| 19 | +### 2. 抽奖页面 | ||
| 20 | +api-online.test.boxfish.cn/share/wechat/acquire/award/{user_id}/{display_code} | ||
| 21 | +GET | ||
| 22 | + | ||
| 23 | + | ||
| 24 | +### 3. 抽奖分享成功回调 | ||
| 25 | +/share/acquire/award/success | ||
| 26 | +POST | ||
| 27 | +说明: 对预存储的积分金币加到用户信息中 | ||
| 28 | + | ||
| 29 | +### 4. 通用分享接口 | ||
| 30 | +/share/for | ||
| 31 | +POST | ||
| 32 | +x-www-form-urlencoded参数: | ||
| 33 | +share_type String 分享类型 | ||
| 34 | +参数约定:分享类型都集成在一个枚举里面, | ||
| 35 | +public enum ShareType { | ||
| 36 | + ACHIEVEMENT, | ||
| 37 | + DAILY_ACHIEVEMENT, | ||
| 38 | + DAILY_GOAL_ACHIEVEMENT, | ||
| 39 | + DAILY_SCORE_RANK, | ||
| 40 | + TOTAL_SCORE_RANK, | ||
| 41 | + OPEN_QUESTION, | ||
| 42 | + AWARD, | ||
| 43 | + REWARD_LESSON, //扫一扫,二维码兑换课程 | ||
| 44 | + ONLINE_LESSON, //在线上课 | ||
| 45 | + BUY_FOREIGN_LESSON, //购买外教课 | ||
| 46 | + BUY_CHINESE_LESSON, //购买中教课 | ||
| 47 | + APPRAISE, //外教点评 | ||
| 48 | + TODAY_HEADLINE, | ||
| 49 | + ORAL_REPORT, //口语测评 | ||
| 50 | + BUY_SMALL_LESSON, | ||
| 51 | + SMALL_LESSON, | ||
| 52 | + PUB_LESSON, | ||
| 53 | + FINISH_STUDY //完成自主学习任务 | ||
| 54 | + | ||
| 55 | +} | ||
| 56 | +接口中的方法对应每一种分享类型的处理方式, | ||
| 57 | +##### 4.1 完成今日任务 FINISH_STUDY | ||
| 58 | +{ | ||
| 59 | + "title" : "BOXFiSH学员:学习全辅导,每天都上外教课!", | ||
| 60 | + "imageName" : "award_logo.png", | ||
| 61 | + "description" : "我在BOXFiSH学英语#学的不止是英语,更是全球视角下的独立思考。", | ||
| 62 | + "award_code":"hahaha", | ||
| 63 | + "lesson_list" : [ { | ||
| 64 | + "lesson_name" : "Module 1 Unit1_Words 1", | ||
| 65 | + "lesson_cover" : "https://api.boxfish.cn/student/publication/data/data/96dc1fd345b6d4eeee82c66c6e3e8ddb", | ||
| 66 | + "lesson_type" : "TEXTBOOK_WORDS" | ||
| 67 | + } ] | ||
| 68 | +} | ||
| 69 | + | ||
| 70 | +##### 4.2 购买小班课 BUY_SMALL_LESSON | ||
| 71 | +{ | ||
| 72 | + "title" : "BOXFiSH学员:学习全辅导,每天都上外教课!", | ||
| 73 | + "imageName" : "award_logo.png", | ||
| 74 | + "description" : "我在BOXFiSH学英语#学的不止是英语,更是全球视角下的独立思考。" | ||
| 75 | +} | ||
| 76 | + | ||
| 77 | +##### 4.3 完成小班课 SMALL_LESSON | ||
| 78 | +{ | ||
| 79 | + "title" : "BOXFiSH学员:学习全辅导,每天都上外教课!", | ||
| 80 | + "imageName" : "award_logo.png", | ||
| 81 | + "description" : "我在BOXFiSH学英语#学的不止是英语,更是全球视角下的独立思考。" | ||
| 82 | +} | ||
| 83 | + | ||
| 84 | + | ||
| 85 | +##### 4.4 完成公开课 PUB_LESSON | ||
| 86 | +{ | ||
| 87 | + "title" : "BOXFiSH学员:学习全辅导,每天都上外教课!", | ||
| 88 | + "imageName" : "award_logo.png", | ||
| 89 | + "description" : "我在BOXFiSH学英语#学的不止是英语,更是全球视角下的独立思考。" | ||
| 90 | +} | ||
| 91 | + | ||
| 92 | + | ||
| 93 | +##### 4.5 口语测评分享 ORAL_REPORT | ||
| 94 | +{ | ||
| 95 | + "report": "0.4", | ||
| 96 | + "lesson_id": "L3NoYXJlL3N2bi_kuIrmtbflj6Por63ogIPor5UxLzUwNC7kuIrmtbfluIIyMDE35Lit6ICD5Y-j6K-t57uD5LmgNC54bHN4", | ||
| 97 | + "dialogue": "0.2分\/10分", | ||
| 98 | + "review": "嘿,整体都可以做得更好呢。注意多练习发音、多交流,表达自己的观点也要具体些~一定要加油哦。", | ||
| 99 | + "title": "我参加了盒子鱼口语考试,超智能!不多说,我继续学习去了。", | ||
| 100 | + "composition": "0.0分\/5分", | ||
| 101 | + "intonation": "0.2分\/5分", | ||
| 102 | + "description": "我在学霸之路上越走越远,你不来比划比划?", | ||
| 103 | + "image_name": "award_logo.png" | ||
| 104 | +} | ||
| 105 | + | ||
| 106 | +##### 4.6 兑换课程分享 | ||
| 107 | +{ | ||
| 108 | + "title" : "BOXFiSH学员:学习全辅导,每天都上外教课!", | ||
| 109 | + "imageName" : "award_logo.png", | ||
| 110 | + "description" : "我在BOXFiSH学英语#学的不止是英语,更是全球视角下的独立思考。", | ||
| 111 | + "view" : "chinese" | ||
| 112 | +} | ||
| 113 | + | ||
| 114 | +##### 4.7 在线上课分享 | ||
| 115 | +{ | ||
| 116 | + "title" : "BOXFiSH学员:学习全辅导,每天都上外教课!", | ||
| 117 | + "imageName" : "award_logo.png", | ||
| 118 | + "description" : "我在BOXFiSH学英语#学的不止是英语,更是全球视角下的独立思考。", | ||
| 119 | + "lessonName" : "L3NoYXJlL3N2bi_mna3lt57lj6Por63ogIPor5UxLzExMS4g5p2t5beeMjAxN-S4reiAg-WPo-ivree7g-S5oDIueGxzeA" | ||
| 120 | +} | ||
| 121 | + | ||
| 122 | +##### 4.8 购买外教课 BUY_FOREIGN_LESSON | ||
| 123 | +{ | ||
| 124 | + "title" : "BOXFiSH学员:学习全辅导,每天都上外教课!", | ||
| 125 | + "imageName" : "award_logo.png", | ||
| 126 | + "description" : "我在BOXFiSH学英语#学的不止是英语,更是全球视角下的独立思考。" | ||
| 127 | +} | ||
| 128 | + | ||
| 129 | +##### 4.9 购买中教课 BUY_CHINESE_LESSON | ||
| 130 | +{ | ||
| 131 | + "title" : "BOXFiSH学员:学习全辅导,每天都上外教课!", | ||
| 132 | + "imageName" : "award_logo.png", | ||
| 133 | + "description" : "我在BOXFiSH学英语#学的不止是英语,更是全球视角下的独立思考。" | ||
| 134 | +} | ||
| 135 | + | ||
| 136 | +##### 4.10 外教点评 APPRAISE | ||
| 137 | +{ | ||
| 138 | + "title" : "BOXFiSH学员:学习全辅导,每天都上外教课!", | ||
| 139 | + "imageName" : "award_logo.png", | ||
| 140 | + "description" : "我在BOXFiSH学英语#学的不止是英语,更是全球视角下的独立思考。" | ||
| 141 | +} |
yjw接口文档/y口语测评.md
0 → 100644
| 1 | +# 口语测评 | ||
| 2 | + | ||
| 3 | +### 1. 口语测评完成度 | ||
| 4 | +api-online.test.boxfish.cn/report/group/{group}}/lesson/{lesson}?access_token=admin | ||
| 5 | +GET | ||
| 6 | +示例: | ||
| 7 | +api-online.test.boxfish.cn/report/group/9469/lesson/L3NoYXJlL3N2bi9Ub3BpY1_kuKrkurrmg4XlhrUvMDAzLuWmguS9leaIkOS4uuabtOWlveeahOiHquW3se-8ny54bHN4?access_token=admin | ||
| 8 | +返回: | ||
| 9 | +{ | ||
| 10 | + "听力测验": [ | ||
| 11 | + { | ||
| 12 | + "user_id": 7007, | ||
| 13 | + "user_name": "Huan", | ||
| 14 | + "score": 0 | ||
| 15 | + } | ||
| 16 | + ], | ||
| 17 | + "type": [ | ||
| 18 | + "听力测验" | ||
| 19 | + ], | ||
| 20 | + "percentage": "0.17" | ||
| 21 | +} | ||
| 22 | +说明:此接口增加了percentage字段,表示班级中已经完成的人数比率 | ||
| 23 | + | ||
| 24 | + | ||
| 25 | +### 2. 口语测评成绩提交 | ||
| 26 | +api-online.test.boxfish.cn/commit/record/batch?access_token=admin | ||
| 27 | +POST | ||
| 28 | +body参数: | ||
| 29 | +{ | ||
| 30 | + "cr_list": [{ | ||
| 31 | + "credit": 1102, | ||
| 32 | + "fact_score": 1.713699913024902, | ||
| 33 | + "quiz_id": "oo-11", | ||
| 34 | + "score": 5, | ||
| 35 | + "equal": 0.3427399826049805, | ||
| 36 | + "gold": 0, | ||
| 37 | + "quiz_type": "ORAL_INTONATION", | ||
| 38 | + "duration": 46.48099899291992, | ||
| 39 | + "audio_url": "http:\/\/edu.hivoice.cn:80\/WebAudio-1.0-SNAPSHOT\/audio\/play\/D923E81D-5D41-402F-9A9C-C471AD18B461\/1483583474648405519\/gz", | ||
| 40 | + "finished_time": 1483583852, | ||
| 41 | + "channel": "ORAL_TEST" | ||
| 42 | + }, { | ||
| 43 | + "credit": 107, | ||
| 44 | + "fact_score": 0.6627500152587891, | ||
| 45 | + "quiz_id": "oo-21", | ||
| 46 | + "score": 1, | ||
| 47 | + "equal": 0.6627500152587891, | ||
| 48 | + "gold": 0, | ||
| 49 | + "quiz_type": "ORAL_DIALOGUE", | ||
| 50 | + "duration": 15.46100044250488, | ||
| 51 | + "audio_url": "http:\/\/edu.hivoice.cn:80\/WebAudio-1.0-SNAPSHOT\/audio\/play\/80B813C9-E2CC-4CF7-AF3C-540A876AED20\/1483583541114792703\/gz", | ||
| 52 | + "finished_time": 1483583852, | ||
| 53 | + "channel": "ORAL_TEST" | ||
| 54 | + }, { | ||
| 55 | + "credit": 307, | ||
| 56 | + "fact_score": 0.6970199775695801, | ||
| 57 | + "quiz_id": "oo-31", | ||
| 58 | + "score": 6, | ||
| 59 | + "equal": 0.1161699962615967, | ||
| 60 | + "gold": 0, | ||
| 61 | + "quiz_type": "ORAL_COMPOSITION", | ||
| 62 | + "duration": 10.84099960327148, | ||
| 63 | + "audio_url": "http:\/\/edu.hivoice.cn:80\/WebAudio-1.0-SNAPSHOT\/audio\/play\/E2B6BDE1-D890-4EA8-AF4A-7D1A819DDFA8\/1483583830243491916\/gz", | ||
| 64 | + "finished_time": 1483583852, | ||
| 65 | + "channel": "ORAL_TEST" | ||
| 66 | + }], | ||
| 67 | + "user_id": "1", | ||
| 68 | + "lesson_id": "L3NoYXJlL3N2bi_ljJfkuqzlj6Por63ogIPor5UxLzEwMi7ljJfkuqzliJ3kuIDlj6Por63nu4PkuaDpopgyLnhsc3gyjw211" | ||
| 69 | +} | ||
| 70 | +返回参数: | ||
| 71 | +{ | ||
| 72 | + "record_score": 70462, | ||
| 73 | + "gold": 4876, | ||
| 74 | + "msg": "success" | ||
| 75 | +} |
yjw接口文档/y提交成绩.md
0 → 100644
This diff is collapsed. Click to expand it.
yjw接口文档/y每日推送.md
0 → 100644
| 1 | +# 每日推送 | ||
| 2 | + | ||
| 3 | +### 1. 文案组生成页面工具接口 | ||
| 4 | + | ||
| 5 | +api-online.test.boxfish.cn/share/wechat/inner/recommendation 不需要token | ||
| 6 | +POST | ||
| 7 | +BODY参数: | ||
| 8 | +{ | ||
| 9 | + "title": "一条大河实在是真特么宽哈", | ||
| 10 | + "description": "alskdjfalks00\n00asldfkaja", | ||
| 11 | + "picUrl": "http://assets.boxfish.cn/images/award/box_open.png", | ||
| 12 | + "videoUrl": "http://assets.boxfish.cn/v/%E6%9E%97%E4%B9%A6%E82%B1%AA%E6%95%99%E5%AD1%A6v4.mp4", | ||
| 13 | + "uploadAt": "2017/03/29", | ||
| 14 | + "recLevel": "3" | ||
| 15 | +} | ||
| 16 | + | ||
| 17 | +### 2. 客户端获取今日推送视频接口 | ||
| 18 | +访问例子: | ||
| 19 | +api-online.test.boxfish.cn/recommendation/today?access_token=admin&preference_level=7 | ||
| 20 | +访问方式:GET | ||
| 21 | +访问参数: | ||
| 22 | +preference_level int类型 即:用户偏好设置 | ||
| 23 | +返回例子: | ||
| 24 | +{ | ||
| 25 | + "upload_at": "2017-03-28", | ||
| 26 | + "title": "test33", | ||
| 27 | + "video_url": "http://assets.boxfish.cn/daily-video/test.mp4", | ||
| 28 | + "description": "test33", | ||
| 29 | + "url": "http://api-online.test.boxfish.cn/share/wechat/access/38da3a2a26b53822b24b6bdca95e92de", | ||
| 30 | + "pic_url": "http://assets.boxfish.cn/daily-video/video-cover/test.jpg" | ||
| 31 | +} | ||
| 32 | + | ||
| 33 | +### 3. 观看视频增加听力时长 | ||
| 34 | +api-online.test.boxfish.cn/finish/recommendation?access_token=admin&listening_time=8 | ||
| 35 | +POST | ||
| 36 | +参数:listening_time 听力时长,单位秒,Long型 | ||
| 37 | +返回: | ||
| 38 | +{ | ||
| 39 | + "msg": "success" | ||
| 40 | +} |
yjw接口文档/y阶段数.md
0 → 100644
| 1 | +# 阶段数 | ||
| 2 | + | ||
| 3 | +### 1. 首页查询阶段数信息 | ||
| 4 | + | ||
| 5 | +api-online.test.boxfish.cn/event/statistic/stage/info?access_token=admin | ||
| 6 | +GET | ||
| 7 | +返回: | ||
| 8 | +{ | ||
| 9 | + "stage_level": 1, | ||
| 10 | + "stage": 1, | ||
| 11 | + "progress": "0.00", | ||
| 12 | + "record_score": 0, | ||
| 13 | + "listening_duration": 8, | ||
| 14 | + "multiword_count": 0 | ||
| 15 | +} | ||
| 16 | + | ||
| 17 | +### 2. 阶段数对学习量预测接口 | ||
| 18 | +api-online.test.boxfish.cn/stage/multiword/info?access_token=admin | ||
| 19 | +GET | ||
| 20 | +返回: | ||
| 21 | +{ | ||
| 22 | + "increment": { | ||
| 23 | + "multi_word_increase": 748, | ||
| 24 | + "word_increase": 706, | ||
| 25 | + "reading_amount_increase": 569, | ||
| 26 | + "listening_time_increase": 8238, | ||
| 27 | + "record_time_increase": 9968, | ||
| 28 | + "phrase_increase": 501 | ||
| 29 | + }, | ||
| 30 | + "weeks": "预计1周完成", | ||
| 31 | + "level": 1, | ||
| 32 | + "stage": 1 | ||
| 33 | +} | ||
| 34 | + | ||
| 35 | +### 3. 首页学习情况显示总量接口 | ||
| 36 | +api-online.test.boxfish.cn/event/statistic/learning/today/progress?access_token=admin | ||
| 37 | +GET | ||
| 38 | +返回: | ||
| 39 | +{ | ||
| 40 | + "wordCount": 0, | ||
| 41 | + "readWordCount": 0, | ||
| 42 | + "recordScore": 0, | ||
| 43 | + "listeningDuration": 8, | ||
| 44 | + "multiwordNum": 0, | ||
| 45 | + "progressTodayStart": "1.719", | ||
| 46 | + "progressTodayNow": "1.719", | ||
| 47 | + "todayScore": 0, | ||
| 48 | + "stageLevel": 1, | ||
| 49 | + "stage": 1 | ||
| 50 | +} | ||
| 51 | + | ||
| 52 | +### 4. 设置学习偏好 | ||
| 53 | +api-online.test.boxfish.cn/preference/setting?access_token=admin | ||
| 54 | +POST | ||
| 55 | +x-www-form-urlencoded参数: | ||
| 56 | +grade="六年级" | ||
| 57 | +publication=“PEP版六年级上” | ||
| 58 | +level=1 | ||
| 59 | +plan=ONE_HOUR | ||
| 60 | +备注:plan约定(HALF_HOUR , ONE_HOUR , TWO_HOUR) | ||
| 61 | +返回: | ||
| 62 | +{ | ||
| 63 | + "goal": { | ||
| 64 | + "id": 1, | ||
| 65 | + "current_step": 3218, | ||
| 66 | + "goal_step": 55000 | ||
| 67 | + } | ||
| 68 | +} | ||
| 69 | + | ||
| 70 | + | ||
| 71 | + | ||
| 72 | +### 5. 设置课程学习计划 | ||
| 73 | +api-online.test.boxfish.cn/preference/purchase/setting?purchase=OPEN_4P&access_token=admin | ||
| 74 | +POST | ||
| 75 | +参数约定: | ||
| 76 | +purchase=OPEN或OPEN_4P或OPEN_1P; | ||
| 77 | +返回: | ||
| 78 | +{ | ||
| 79 | + "msg": "success" | ||
| 80 | +} |
-
Please register or login to post a comment