Showing
1 changed file
with
219 additions
and
0 deletions
9-1相关/9-1版本相关接口.md
0 → 100644
| 1 | + | ||
| 2 | +# 9.1接口文档: | ||
| 3 | + | ||
| 4 | +- 完成任务分享接口 | ||
| 5 | + | ||
| 6 | +路径: | ||
| 7 | +api-online.test.boxfish.cn/share/for?share_type=FINISH_STUDY&access_token=admin | ||
| 8 | + | ||
| 9 | +方式: | ||
| 10 | +POST | ||
| 11 | + | ||
| 12 | + 参数例子: | ||
| 13 | + { | ||
| 14 | + "title" : "BOXFiSH学员:学习全辅导,每天都上外教课!", | ||
| 15 | + "imageName" : "award_logo.png", | ||
| 16 | + "description" : "我在BOXFiSH学英语#学的不止是英语,更是全球视角下的独立思考。", | ||
| 17 | + "award_code":"hahaha", | ||
| 18 | + "lesson_list":[ | ||
| 19 | + { | ||
| 20 | + "lesson_name" : "lesson_name1", | ||
| 21 | + "lesson_cover" : "lesson_cover1", | ||
| 22 | + "lesson_type" : "lesson_type1" | ||
| 23 | + }, | ||
| 24 | + { | ||
| 25 | + "lesson_name" : "lesson_name2", | ||
| 26 | + "lesson_cover" : "lesson_cover2", | ||
| 27 | + "lesson_type" : "lesson_type2" | ||
| 28 | + }, | ||
| 29 | + { | ||
| 30 | + "lesson_name" : "lesson_name3", | ||
| 31 | + "lesson_cover" : "lesson_cover3", | ||
| 32 | + "lesson_type" : "lesson_type3" | ||
| 33 | + } | ||
| 34 | + ] | ||
| 35 | + } | ||
| 36 | + | ||
| 37 | + 返回结果例子: | ||
| 38 | + | ||
| 39 | + { | ||
| 40 | + "online_score": "106", | ||
| 41 | + "gold": "633", | ||
| 42 | + "msg": "success", | ||
| 43 | + "url": "http://api-online.test.boxfish.cn/share/wechat/finish/study/1/b834bf2e-2244-4884-a0ed-050ce0fa8c62" | ||
| 44 | + | ||
| 45 | + } | ||
| 46 | + | ||
| 47 | + | ||
| 48 | + | ||
| 49 | +- 阶段预测接口 | ||
| 50 | + | ||
| 51 | +路径: | ||
| 52 | + | ||
| 53 | +api-online.test.boxfish.cn/stage/multiword/info?access_token=JWEIEfGYly | ||
| 54 | + | ||
| 55 | +方式: | ||
| 56 | + | ||
| 57 | +GET | ||
| 58 | + | ||
| 59 | + 返回结果例子: | ||
| 60 | + { | ||
| 61 | + "increment": { | ||
| 62 | + "multi_word_increase": 1256, | ||
| 63 | + "word_increase": 1151, | ||
| 64 | + "reading_amount_increase": 3001, | ||
| 65 | + "listening_time_increase": 33060, | ||
| 66 | + "record_score_increase": 0, | ||
| 67 | + "phrase_increase": 0 | ||
| 68 | + }, | ||
| 69 | + "weeks": "预计2周完成", | ||
| 70 | + "level": 2, | ||
| 71 | + "stage": "第一阶段" | ||
| 72 | + } | ||
| 73 | + | ||
| 74 | + | ||
| 75 | + | ||
| 76 | + - 完成任务分享接口 | ||
| 77 | +路径: | ||
| 78 | + | ||
| 79 | +api-online.test.boxfish.cn/share/for?share_type=FINISH_STUDY&access_token=admin | ||
| 80 | + | ||
| 81 | +方式: | ||
| 82 | + | ||
| 83 | +POST | ||
| 84 | + | ||
| 85 | + 参数例子: | ||
| 86 | + { | ||
| 87 | + "title" : "BOXFiSH学员:学习全辅导,每天都上外教课!", | ||
| 88 | + "imageName" : "award_logo.png", | ||
| 89 | + "description" : "我在BOXFiSH学英语#学的不止是英语,更是全球视角下的独立思考。", | ||
| 90 | + "award_code":"这里是奖品码参数" | ||
| 91 | + } | ||
| 92 | + 返回结果例子: | ||
| 93 | + { | ||
| 94 | + "score": "106", | ||
| 95 | + "gold": "633", | ||
| 96 | + "msg": "success", | ||
| 97 | + "url": "http://api-online.test.boxfish.cn/share/wechat/finish/study/1/b834bf2e-2244-4884-a0ed-050ce0fa8c62" | ||
| 98 | + } | ||
| 99 | + | ||
| 100 | + - 完成任务分享 - 分享成功 | ||
| 101 | + | ||
| 102 | +路径: | ||
| 103 | + | ||
| 104 | +/successful/share?access_token=admin&share_type=FINISH_STUDY | ||
| 105 | + | ||
| 106 | +方式: | ||
| 107 | + | ||
| 108 | +POST | ||
| 109 | + | ||
| 110 | +路径参数: | ||
| 111 | +share_type=FINISH_STUDY | ||
| 112 | + | ||
| 113 | +body参数: | ||
| 114 | + | ||
| 115 | + | ||
| 116 | + { | ||
| 117 | + "url":"http://localhost/share/wechat/finish/study/1299909/16f3cbf6-4922-4ce4-af60-21b2742bb8b2", | ||
| 118 | + "platform":"QQ" | ||
| 119 | + } | ||
| 120 | + | ||
| 121 | + | ||
| 122 | + | ||
| 123 | + | ||
| 124 | + | ||
| 125 | + | ||
| 126 | + - user/me | ||
| 127 | + | ||
| 128 | + 路径: | ||
| 129 | + | ||
| 130 | + user/me | ||
| 131 | + | ||
| 132 | + 方式: | ||
| 133 | + | ||
| 134 | + GET | ||
| 135 | + | ||
| 136 | + | ||
| 137 | + 返回参数: | ||
| 138 | + { | ||
| 139 | + "grade": "六年级", | ||
| 140 | + "difficulty": "5", | ||
| 141 | + "courseLevel": "5", | ||
| 142 | + "publication": "PEP版六年级上", | ||
| 143 | + "updateTime": "2017-03-09 19:06:29.0", | ||
| 144 | + "update_at": "2017-03-09 19:06:29.0", | ||
| 145 | + "plan": "ONE_HOUR", | ||
| 146 | + "purchase": "OPEN_4P", | ||
| 147 | + "mobile": "18264160050", | ||
| 148 | + "interface_version": { | ||
| 149 | + "finished": "2016-09-03T17:00:47.815", | ||
| 150 | + "score": "2016-09-03T17:00:47.815", | ||
| 151 | + "buy": "2016-09-03T17:00:47.815", | ||
| 152 | + "synchronize_word": 1 | ||
| 153 | + }, | ||
| 154 | + "id": 1, | ||
| 155 | + "username": "admin", | ||
| 156 | + "nickname": "拒绝黄赌毒", | ||
| 157 | + "realname": "盒子鱼", | ||
| 158 | + "figure_url": "https://avatars.boxfish.cn/user/-12/figure/1411532427.jpg", | ||
| 159 | + "catalog": "初中", | ||
| 160 | + "completed": 6, | ||
| 161 | + "first_login": true, | ||
| 162 | + "gift": [ | ||
| 163 | + "lesson_convert_score" | ||
| 164 | + ], | ||
| 165 | + "score": 372738, | ||
| 166 | + "goal": { | ||
| 167 | + "id": 1, | ||
| 168 | + "goal_step": 55000, | ||
| 169 | + "current_step": 3218 | ||
| 170 | + }, | ||
| 171 | + "queue": { | ||
| 172 | + "log_queue_url": "http://cropd5q7bl.mqs-cn-hangzhou.aliyuncs.com/", | ||
| 173 | + "log_queue_name": "test-boxfish-log", | ||
| 174 | + "event_queue_url": "http://cropd5q7bl.mqs-cn-hangzhou.aliyuncs.com/", | ||
| 175 | + "event_queue_name": "test-boxfish-word-event", | ||
| 176 | + "log_mns_queue_url": "https://1296825402699921.mns.cn-hangzhou.aliyuncs.com/", | ||
| 177 | + "log_mns_queue_name": "test-boxfish-log", | ||
| 178 | + "event_mns_queue_url": "https://1296825402699921.mns.cn-hangzhou.aliyuncs.com/", | ||
| 179 | + "event_mns_queue_name": "test-boxfish-word-event" | ||
| 180 | + }, | ||
| 181 | + "easemob_username": "c4ca4238a0b923820dcc509a6f75849b", | ||
| 182 | + "easemob_password": "bc7235a51e34c1d3ebfddeb538c20c71", | ||
| 183 | + "current_login_type": "email", | ||
| 184 | + "today_score": 0, | ||
| 185 | + "qcloud": { | ||
| 186 | + "identifier": "c4ca4238a0b923820dcc509a6f75849b", | ||
| 187 | + "sign": "eJxFkFFPgzAQx78Lz8ZcSzuoiQ9sOEUhEecc7IWUUlidMOy6yTR*dxlh8emS3*8ud--7sV7DxTVvW1Vk3GS2LqwbC6yrAcuuVVpmvDRS9xhRSjHAxR6l3qtd0wsMiCJsA-xLVcjGqFINg4IITrDtcshZXzAUQlBgfFI61CUsH2f2quqbo7vlLIj9JEafkVOlm-hZvYuHwyM6QuIGH2lrnrbGv69MINcz031-eUG1mmO*Cb2lnMOb8bvEneomJKtpzV5wukj0up7oHEFUnrzby7Jimw2xz8HI*XJiUzpKo2o5cJchmzrARs6F2B0ak5lTK4c--f4BR3Bemg__" | ||
| 188 | + }, | ||
| 189 | + "version": "100.0.0", | ||
| 190 | + " is_school_student": true, | ||
| 191 | + "user_role": [ | ||
| 192 | + "user", | ||
| 193 | + "teacher", | ||
| 194 | + "student" | ||
| 195 | + ] | ||
| 196 | + } | ||
| 197 | + | ||
| 198 | + | ||
| 199 | + - 新版首页 | ||
| 200 | + | ||
| 201 | + /event/statistic/stage/info | ||
| 202 | + | ||
| 203 | + 方式: | ||
| 204 | + | ||
| 205 | + GET | ||
| 206 | + | ||
| 207 | + | ||
| 208 | + 返回参数: | ||
| 209 | + { | ||
| 210 | + "stage_level": 3, | ||
| 211 | + "stage": 1, | ||
| 212 | + "progress": "0.00", | ||
| 213 | + "record_score": 0, | ||
| 214 | + "listening_duration": 0, | ||
| 215 | + "multiword_count": 0 | ||
| 216 | + } | ||
| 217 | + | ||
| 218 | + | ||
| 219 | + |
-
Please register or login to post a comment