9-1版本相关接口.md 5.2 KB

9.1接口文档:

  • 完成任务分享接口

路径: api-online.test.boxfish.cn/share/for?share_type=FINISH_STUDY&access_token=admin

方式: POST

参数例子:
{
   "title" : "BOXFiSH学员:学习全辅导,每天都上外教课!",
   "imageName" : "award_logo.png",
   "description" : "我在BOXFiSH学英语#学的不止是英语,更是全球视角下的独立思考。",
   "award_code":"hahaha",
   "lesson_list":[
    {
        "lesson_name" : "lesson_name1",
        "lesson_cover" : "lesson_cover1",
        "lesson_type" : "lesson_type1"
    },
    {
        "lesson_name" : "lesson_name2",
        "lesson_cover" : "lesson_cover2",
        "lesson_type" : "lesson_type2"
    },
    {
        "lesson_name" : "lesson_name3",
        "lesson_cover" : "lesson_cover3",
        "lesson_type" : "lesson_type3"
    }
    ]
 }

 返回结果例子:

 {
     "online_score": "106",
     "gold": "633",
     "msg": "success",
     "url": "http://api-online.test.boxfish.cn/share/wechat/finish/study/1/b834bf2e-2244-4884-a0ed-050ce0fa8c62"

 }
  • 阶段预测接口

路径:

api-online.test.boxfish.cn/stage/multiword/info?access_token=JWEIEfGYly

方式:

GET

返回结果例子:
{
"increment": {
"multi_word_increase": 1256,
"word_increase": 1151,
"reading_amount_increase": 3001,
"listening_time_increase": 33060,
"record_score_increase": 0,
"phrase_increase": 0
},
"weeks": "预计2周完成",
"level": 2,
"stage": "第一阶段"
}
  • 完成任务分享接口 路径:

api-online.test.boxfish.cn/share/for?share_type=FINISH_STUDY&access_token=admin

方式:

POST

 参数例子:
  {
    "title" : "BOXFiSH学员:学习全辅导,每天都上外教课!",
    "imageName" : "award_logo.png",
    "description" : "我在BOXFiSH学英语#学的不止是英语,更是全球视角下的独立思考。",
    "award_code":"这里是奖品码参数"
  }
  返回结果例子:
 {
   "score": "106",
   "gold": "633",
   "msg": "success",
   "url": "http://api-online.test.boxfish.cn/share/wechat/finish/study/1/b834bf2e-2244-4884-a0ed-050ce0fa8c62"
 }
  • 完成任务分享 - 分享成功

路径:

/successful/share?access_token=admin&share_type=FINISH_STUDY

方式:

POST

路径参数: share_type=FINISH_STUDY

body参数:

 {
     "url":"http://localhost/share/wechat/finish/study/1299909/16f3cbf6-4922-4ce4-af60-21b2742bb8b2",
    "platform":"QQ"
}
  • user/me

路径:

user/me

方式:

GET

   返回参数:
   {
     "grade": "六年级",
     "difficulty": "5",
     "courseLevel": "5",
     "publication": "PEP版六年级上",
     "updateTime": "2017-03-09 19:06:29.0",
     "update_at": "2017-03-09 19:06:29.0",
     "plan": "ONE_HOUR",
     "purchase": "OPEN_4P",
     "mobile": "18264160050",
     "interface_version": {
       "finished": "2016-09-03T17:00:47.815",
       "score": "2016-09-03T17:00:47.815",
       "buy": "2016-09-03T17:00:47.815",
      "synchronize_word": 1
    },
    "id": 1,
    "username": "admin",
    "nickname": "拒绝黄赌毒",
    "realname": "盒子鱼",
    "figure_url":        "https://avatars.boxfish.cn/user/-12/figure/1411532427.jpg",
    "catalog": "初中",
    "completed": 6,
    "first_login": true,
    "gift": [
      "lesson_convert_score"
    ],
    "score": 372738,
    "goal": {
    "id": 1,
    "goal_step": 55000,
    "current_step": 3218
   },
   "queue": {
   "log_queue_url": "http://cropd5q7bl.mqs-cn-hangzhou.aliyuncs.com/",
   "log_queue_name": "test-boxfish-log",
   "event_queue_url": "http://cropd5q7bl.mqs-cn-hangzhou.aliyuncs.com/",
   "event_queue_name": "test-boxfish-word-event",
   "log_mns_queue_url": "https://1296825402699921.mns.cn-hangzhou.aliyuncs.com/",
   "log_mns_queue_name": "test-boxfish-log",
   "event_mns_queue_url": "https://1296825402699921.mns.cn-hangzhou.aliyuncs.com/",
   "event_mns_queue_name": "test-boxfish-word-event"
   },
   "easemob_username": "c4ca4238a0b923820dcc509a6f75849b",
   "easemob_password": "bc7235a51e34c1d3ebfddeb538c20c71",
   "current_login_type": "email",
   "today_score": 0,
   "qcloud": {
   "identifier": "c4ca4238a0b923820dcc509a6f75849b",
   "sign": "eJxFkFFPgzAQx78Lz8ZcSzuoiQ9sOEUhEecc7IWUUlidMOy6yTR*dxlh8emS3*8ud--7sV7DxTVvW1Vk3GS2LqwbC6yrAcuuVVpmvDRS9xhRSjHAxR6l3qtd0wsMiCJsA-xLVcjGqFINg4IITrDtcshZXzAUQlBgfFI61CUsH2f2quqbo7vlLIj9JEafkVOlm-hZvYuHwyM6QuIGH2lrnrbGv69MINcz031-eUG1mmO*Cb2lnMOb8bvEneomJKtpzV5wukj0up7oHEFUnrzby7Jimw2xz8HI*XJiUzpKo2o5cJchmzrARs6F2B0ak5lTK4c--f4BR3Bemg__"
   },
   "version": "100.0.0",
   " is_school_student": true,
   "user_role": [
   "user",
   "teacher",
   "student"
   ]
}
  • 新版首页

/event/statistic/stage/info

方式:

GET

  返回参数:
  {
     "stage_level": 3,
     "stage": 1,
     "progress": "0.00",
     "record_score": 0,
     "listening_duration": 0,
     "multiword_count": 0
  }