liuming / developer-docs

Go to a project
Toggle navigation Toggle navigation pinning
闫镜湾
2246fc7e 1 parent c5b0a164

接口文档

Expand all
Inline Side-by-side
Showing 5 changed files with 336 additions and 0 deletions
# 分享相关
### 1. 抽奖分享
api-online.test.boxfish.cn/share/acquire/award?access_token=admin
POST
x-www-form-urlencoded参数：
award_code String 奖品码
image_name String 图片名字
title String 小标题
description String 副标题
返回：
{
"gold": 173,
"msg": "success",
"onlineScore": 217,
"url": "http://api-online.test.boxfish.cn/share/wechat/acquire/award/1/86995d7a-4916-4e25-9b9e-85bc38a49f21"
}
### 2. 抽奖页面
api-online.test.boxfish.cn/share/wechat/acquire/award/{user_id}/{display_code}
GET
### 3. 抽奖分享成功回调
/share/acquire/award/success
POST
说明： 对预存储的积分金币加到用户信息中
### 4. 通用分享接口
/share/for
POST
x-www-form-urlencoded参数：
share_type String 分享类型
参数约定：分享类型都集成在一个枚举里面，
public enum ShareType {
ACHIEVEMENT,
DAILY_ACHIEVEMENT,
DAILY_GOAL_ACHIEVEMENT,
DAILY_SCORE_RANK,
TOTAL_SCORE_RANK,
OPEN_QUESTION,
AWARD,
REWARD_LESSON, //扫一扫,二维码兑换课程
ONLINE_LESSON, //在线上课
BUY_FOREIGN_LESSON, //购买外教课
BUY_CHINESE_LESSON, //购买中教课
APPRAISE, //外教点评
TODAY_HEADLINE,
ORAL_REPORT, //口语测评
BUY_SMALL_LESSON,
SMALL_LESSON,
PUB_LESSON,
FINISH_STUDY //完成自主学习任务
}
接口中的方法对应每一种分享类型的处理方式，
##### 4.1 完成今日任务 FINISH_STUDY
{
"title" : "BOXFiSH学员：学习全辅导，每天都上外教课！",
"imageName" : "award_logo.png",
"description" : "我在BOXFiSH学英语＃学的不止是英语，更是全球视角下的独立思考。",
"award_code":"hahaha",
"lesson_list" : [ {
"lesson_name" : "Module 1 Unit1_Words 1",
"lesson_cover" : "https://api.boxfish.cn/student/publication/data/data/96dc1fd345b6d4eeee82c66c6e3e8ddb",
"lesson_type" : "TEXTBOOK_WORDS"
} ]
}
##### 4.2 购买小班课 BUY_SMALL_LESSON
{
"title" : "BOXFiSH学员：学习全辅导，每天都上外教课！",
"imageName" : "award_logo.png",
"description" : "我在BOXFiSH学英语＃学的不止是英语，更是全球视角下的独立思考。"
}
##### 4.3 完成小班课 SMALL_LESSON
{
"title" : "BOXFiSH学员：学习全辅导，每天都上外教课！",
"imageName" : "award_logo.png",
"description" : "我在BOXFiSH学英语＃学的不止是英语，更是全球视角下的独立思考。"
}
##### 4.4 完成公开课 PUB_LESSON
{
"title" : "BOXFiSH学员：学习全辅导，每天都上外教课！",
"imageName" : "award_logo.png",
"description" : "我在BOXFiSH学英语＃学的不止是英语，更是全球视角下的独立思考。"
}
##### 4.5 口语测评分享 ORAL_REPORT
{
"report": "0.4",
"lesson_id": "L3NoYXJlL3N2bi_kuIrmtbflj6Por63ogIPor5UxLzUwNC7kuIrmtbfluIIyMDE35Lit6ICD5Y-j6K-t57uD5LmgNC54bHN4",
"dialogue": "0.2分\/10分",
"review": "嘿，整体都可以做得更好呢。注意多练习发音、多交流，表达自己的观点也要具体些～一定要加油哦。",
"title": "我参加了盒子鱼口语考试，超智能！不多说，我继续学习去了。",
"composition": "0.0分\/5分",
"intonation": "0.2分\/5分",
"description": "我在学霸之路上越走越远，你不来比划比划？",
"image_name": "award_logo.png"
}
##### 4.6 兑换课程分享
{
"title" : "BOXFiSH学员：学习全辅导，每天都上外教课！",
"imageName" : "award_logo.png",
"description" : "我在BOXFiSH学英语＃学的不止是英语，更是全球视角下的独立思考。",
"view" : "chinese"
}
##### 4.7 在线上课分享
{
"title" : "BOXFiSH学员：学习全辅导，每天都上外教课！",
"imageName" : "award_logo.png",
"description" : "我在BOXFiSH学英语＃学的不止是英语，更是全球视角下的独立思考。",
"lessonName" : "L3NoYXJlL3N2bi_mna3lt57lj6Por63ogIPor5UxLzExMS4g5p2t5beeMjAxN-S4reiAg-WPo-ivree7g-S5oDIueGxzeA"
}
##### 4.8 购买外教课 BUY_FOREIGN_LESSON
{
"title" : "BOXFiSH学员：学习全辅导，每天都上外教课！",
"imageName" : "award_logo.png",
"description" : "我在BOXFiSH学英语＃学的不止是英语，更是全球视角下的独立思考。"
}
##### 4.9 购买中教课 BUY_CHINESE_LESSON
{
"title" : "BOXFiSH学员：学习全辅导，每天都上外教课！",
"imageName" : "award_logo.png",
"description" : "我在BOXFiSH学英语＃学的不止是英语，更是全球视角下的独立思考。"
}
##### 4.10 外教点评 APPRAISE
{
"title" : "BOXFiSH学员：学习全辅导，每天都上外教课！",
"imageName" : "award_logo.png",
"description" : "我在BOXFiSH学英语＃学的不止是英语，更是全球视角下的独立思考。"
}
... ...
# 口语测评
### 1. 口语测评完成度
api-online.test.boxfish.cn/report/group/{group}}/lesson/{lesson}?access_token=admin
GET
示例：
api-online.test.boxfish.cn/report/group/9469/lesson/L3NoYXJlL3N2bi9Ub3BpY1_kuKrkurrmg4XlhrUvMDAzLuWmguS9leaIkOS4uuabtOWlveeahOiHquW3se-8ny54bHN4?access_token=admin
返回：
{
"听力测验": [
{
"user_id": 7007,
"user_name": "Huan",
"score": 0
}
],
"type": [
"听力测验"
],
"percentage": "0.17"
}
说明：此接口增加了percentage字段，表示班级中已经完成的人数比率
### 2. 口语测评成绩提交
api-online.test.boxfish.cn/commit/record/batch?access_token=admin
POST
body参数：
{
"cr_list": [{
"credit": 1102,
"fact_score": 1.713699913024902,
"quiz_id": "oo-11",
"score": 5,
"equal": 0.3427399826049805,
"gold": 0,
"quiz_type": "ORAL_INTONATION",
"duration": 46.48099899291992,
"audio_url": "http:\/\/edu.hivoice.cn:80\/WebAudio-1.0-SNAPSHOT\/audio\/play\/D923E81D-5D41-402F-9A9C-C471AD18B461\/1483583474648405519\/gz",
"finished_time": 1483583852,
"channel": "ORAL_TEST"
}, {
"credit": 107,
"fact_score": 0.6627500152587891,
"quiz_id": "oo-21",
"score": 1,
"equal": 0.6627500152587891,
"gold": 0,
"quiz_type": "ORAL_DIALOGUE",
"duration": 15.46100044250488,
"audio_url": "http:\/\/edu.hivoice.cn:80\/WebAudio-1.0-SNAPSHOT\/audio\/play\/80B813C9-E2CC-4CF7-AF3C-540A876AED20\/1483583541114792703\/gz",
"finished_time": 1483583852,
"channel": "ORAL_TEST"
}, {
"credit": 307,
"fact_score": 0.6970199775695801,
"quiz_id": "oo-31",
"score": 6,
"equal": 0.1161699962615967,
"gold": 0,
"quiz_type": "ORAL_COMPOSITION",
"duration": 10.84099960327148,
"audio_url": "http:\/\/edu.hivoice.cn:80\/WebAudio-1.0-SNAPSHOT\/audio\/play\/E2B6BDE1-D890-4EA8-AF4A-7D1A819DDFA8\/1483583830243491916\/gz",
"finished_time": 1483583852,
"channel": "ORAL_TEST"
}],
"user_id": "1",
"lesson_id": "L3NoYXJlL3N2bi_ljJfkuqzlj6Por63ogIPor5UxLzEwMi7ljJfkuqzliJ3kuIDlj6Por63nu4PkuaDpopgyLnhsc3gyjw211"
}
返回参数：
{
"record_score": 70462,
"gold": 4876,
"msg": "success"
}
... ...
This diff is collapsed. Click to expand it.
# 每日推送
### 1. 文案组生成页面工具接口
api-online.test.boxfish.cn/share/wechat/inner/recommendation 不需要token
POST
BODY参数：
{
"title": "一条大河实在是真特么宽哈",
"description": "alskdjfalks00\n00asldfkaja",
"picUrl": "http://assets.boxfish.cn/images/award/box_open.png",
"videoUrl": "http://assets.boxfish.cn/v/%E6%9E%97%E4%B9%A6%E82%B1%AA%E6%95%99%E5%AD1%A6v4.mp4",
"uploadAt": "2017/03/29",
"recLevel": "3"
}
### 2. 客户端获取今日推送视频接口
访问例子:
api-online.test.boxfish.cn/recommendation/today?access_token=admin&preference_level=7
访问方式：GET
访问参数：
preference_level int类型 即：用户偏好设置
返回例子：
{
"upload_at": "2017-03-28",
"title": "test33",
"video_url": "http://assets.boxfish.cn/daily-video/test.mp4",
"description": "test33",
"url": "http://api-online.test.boxfish.cn/share/wechat/access/38da3a2a26b53822b24b6bdca95e92de",
"pic_url": "http://assets.boxfish.cn/daily-video/video-cover/test.jpg"
}
### 3. 观看视频增加听力时长
api-online.test.boxfish.cn/finish/recommendation?access_token=admin&listening_time=8
POST
参数：listening_time 听力时长，单位秒，Long型
返回：
{
"msg": "success"
}
... ...
# 阶段数
### 1. 首页查询阶段数信息
api-online.test.boxfish.cn/event/statistic/stage/info?access_token=admin
GET
返回：
{
"stage_level": 1,
"stage": 1,
"progress": "0.00",
"record_score": 0,
"listening_duration": 8,
"multiword_count": 0
}
### 2. 阶段数对学习量预测接口
api-online.test.boxfish.cn/stage/multiword/info?access_token=admin
GET
返回：
{
"increment": {
"multi_word_increase": 748,
"word_increase": 706,
"reading_amount_increase": 569,
"listening_time_increase": 8238,
"record_time_increase": 9968,
"phrase_increase": 501
},
"weeks": "预计1周完成",
"level": 1,
"stage": 1
}
### 3. 首页学习情况显示总量接口
api-online.test.boxfish.cn/event/statistic/learning/today/progress?access_token=admin
GET
返回：
{
"wordCount": 0,
"readWordCount": 0,
"recordScore": 0,
"listeningDuration": 8,
"multiwordNum": 0,
"progressTodayStart": "1.719",
"progressTodayNow": "1.719",
"todayScore": 0,
"stageLevel": 1,
"stage": 1
}
### 4. 设置学习偏好
api-online.test.boxfish.cn/preference/setting?access_token=admin
POST
x-www-form-urlencoded参数：
grade="六年级"
publication=“PEP版六年级上”
level=1
plan=ONE_HOUR
备注：plan约定（HALF_HOUR , ONE_HOUR , TWO_HOUR）
返回：
{
"goal": {
"id": 1,
"current_step": 3218,
"goal_step": 55000
}
}
### 5. 设置课程学习计划
api-online.test.boxfish.cn/preference/purchase/setting?purchase=OPEN_4P&access_token=admin
POST
参数约定：
purchase=OPEN或OPEN_4P或OPEN_1P;
返回:
{
"msg": "success"
}
... ...