huayandong / recommend-api

Go to a project
Toggle navigation Toggle navigation pinning
Switch branch/tag
card-学员信息接口.md 12.6 KB

996.icu

获取学员身份信息接口

1. 【APP接口】获取学员信息
  • URL: {{localhost}}/boxfish-online-card/member/info/getMemberInfo?access_token={{token}}

  • Method: GET

  • ResponseBody:

public class MemberSummary implements BeanToJson {

    private Long userId;
    private MemberTypeEnum memberType;      // 学员身份
    private DateTime expireTimeMember;      // 学员过期时间

    private MemberTypeEnum memberTypeV2;    // 新版本用户身份

    private Integer amountClassSvValid;     // 外教练习 剩余次数
    private Integer amountClassSvFinished;  // 外教练习 完成次数
    private DateTime expireTimeClassSv;     // 外教练习 过期时间

    private Integer amountClassSv10Valid;   // 外教练习 10分钟 剩余次数

    private String expireDescClassSv5;      // 外教练习5分钟 过期描述
    private String expireDescClassSv10;     // 外教练习10分钟 过期描述

    private Integer amountExamOral;         // 口语考试 剩余次数
    private DateTime expireTimeExamOral;    // 口语考试 过期时间

    private Integer amountOpenCn;           // 中教名师课 剩余次数
    private DateTime expireTimeOpenCn;      // 中教名师课 过期时间
    private String expireDescOpenCn;        // 中教名师课 过期描述

    private Integer amountOpenUs;           // 外教名师课 剩余次数
    private DateTime expireTimeOpenUs;      // 外教名师课 过期时间
    private String expireDescOpenUs;        // 外教名师课 过期描述

    private Boolean flagPaperV1Auth;        // 纸质三件套 权限
    private DateTime expireTimePaperV1;     // 智能三件套 过期时间

    private Long classSmallId;              // 小班课ID
    private String classSmallName;          // 小班课名称
    private Integer amountClassSmall;       // 小班课数量

    private Integer amountCash;             // 剩余奖学金

    private Boolean flagJhxxqAuth;          // 精华小学期 使用权限
    private DateTime expireTimeJhxxq;       // 精华小学期 过期时间

    private Boolean flagUserIsPaid;         // 用户是否为 付费用户
    private Boolean flagUserHasAddressInfo; // 是否填过领取地址

    // 四会课 单词
    private Boolean flagPaperTextbookAuth;      // 纸质四会课 权限
    private DateTime expireTimePaperTextbook;   // 纸质四会课 过期时间

    // BASIC套餐 知识点
    private Boolean flagUserHasBasic_KNOWLEDGE;  // 是否购买 BASIC 套餐
    private DateTime expireTimeBasic_KNOWLEDGE;  // BASIC 套餐过期时间
    // BASIC套餐 单词
    private Boolean flagUserHasBasic_WORD;       // 是否购买 BASIC 套餐
    private DateTime expireTimeBasic_WORD;       // BASIC 套餐过期时间

    private Boolean flagShowAddressButton_WORD;     // 四会单词课 是否显示填写地址按钮
    private Boolean flagShowAddressButton_XXQ;      // 小学期 是否显示填写地址按钮
}
2. 【APP接口】新注册用户查询领取福利的接口
  • URL: {{localhost}}/boxfish-online-card/member/register/getMemberWelfare?access_token={{token}}
  • Method: POST

  • RequestBody

  • ResponseBody

{
    "welfareSummaryList": [
        {
            "type": "BASIC_WORD",
            "orderIndex": 1,
            "videoUrl": "https://assets.boxfish.cn/v/video_word4.mp4",
            "videoCover_PAD": "https://avatars.boxfish.cn/app_resources/welfare_video_cover_textbook_word_ipad.png",
            "videoCover_PHONE": "https://avatars.boxfish.cn/app_resources/welfare_video_cover_textbook_word_iphone.png",
            "welfareTitle": "智能四会单词课",
            "welfareDescList": [
                {
                    "welfareUnit": "1学期",
                    "welfareDesc": "智能四会单词课"
                }
            ]
        },
        {
            "type": "ADVANCED",
            "orderIndex": 3,
            "videoUrl": "https://assets.boxfish.cn/v/video_innovation.mp4",
            "videoCover_PAD": "https://avatars.boxfish.cn/app_resources/welfare_video_cover_harvard_ipad.png",
            "videoCover_PHONE": "https://avatars.boxfish.cn/app_resources/welfare_video_cover_harvard_iphone.png",
            "welfareTitle": "精华小学期",
            "flagWxObtain": true,
            "welfareDescList": [
                {
                    "welfareUnit": "4节",
                    "welfareDesc": "语言点智能学练课"
                },
                {
                    "welfareUnit": "2节",
                    "welfareDesc": "中外教翻转小班课"
                }
            ]
        }
    ]
}

type可能的值为：BASIC_WORD、ADVANCED、INTERNATIONAL。

3. 【APP接口】新注册用户查询显示"Free已领取"标签的接口
  • URL: {{localhost}}/boxfish-online-card/member/register/getTag?access_token={{token}}

  • Method: POST

  • ResponseBody

{
  "tagTypeList": [
    "BASIC_TEXTBOOK_V1_WORD"
  ]
}

"tagTypeList"为枚举类型，枚举值为：
BASIC_TEXTBOOK_V1_WORD：智能教材同步学模块
BASIC_TEXTBOOK_V2_WORD：四会单词课模块

4. 【APP接口】点击 "Free已领取" 标签消失接口
  • URL: {{localhost}}/boxfish-online-card/member/register/clickTag?access_token={{token}}
  • Method: POST
  • RequestBody
{
  "type": "BASIC_TEXTBOOK_V1_WORD"
}

"type"为枚举类型，枚举值为：
BASIC_TEXTBOOK_V1_WORD：智能教材同步学模块
BASIC_TEXTBOOK_V2_WORD：四会单词课模块

  • ResponseBody
5. 【APP接口】四会课程书的列表接口
  • URL: {{localhost}}/boxfish-wudaokou-paper/paper/textbook/getTextbookCourseSummary?access_token=l1RaF90wsf
  • Method: POST
  • RequestBody
{
    "textbookType":"PAPER_TEXTBOOK_WORD"
}
  • ResponseBody
{
    "bookList": [
        {
            "bookId": 226,
            "bookName": "智能同步四会单词课 北京版一年级下",
            "paperNameList": [
                "北京版一年级下U1L1",
                "北京版一年级下U1L2",
                "北京版一年级下U1L3"
            ]
        }
    ]
}
6. 【APP接口】四会课程 课的列表接口
  • URL: {{localhost}}/boxfish-wudaokou-paper/paper/textbook/getTextbookCourseList?access_token=l1RaF90wsf
  • Method: POST
  • RequestBody
{
    "bookId": 226,
    "textbookType": "PAPER_TEXTBOOK_WORD"
}
  • ResponseBody
7. 【APP接口】四会课程 进课前检查是否有课程权限接口
  • URL: {{localhost}}/boxfish-wudaokou-paper/paper/textbook/getTextbookCourseAuth?access_token={{token}}
  • Method: POST
  • RequestBody
{
    "courseId": "L3NoYXJlL3N2bi_ljJfkuqzniYjlsI_lrabkuIDkuIsgVTEvMTEyLldvcmRzX-WMl-S6rOeJiOS4gOW5tOe6p-S4i1UxTDIueGxzeA"
}
  • ResponseBody
{
    "status": "ERROR",
    "type": "COURSE_NOT_TEXTBOOK_WORD",
    "message": "当前课程不是智能四会单词课"
}

学生有权限: status="SUCCESS";
学生没有权限: status="ERROR", type="USER_NO_TEXTBOOK_WORD_AUTH";
课程不是四会单词课: status="ERROR", type="COURSE_NOT_TEXTBOOK_WORD";

8. 【APP接口】basic课程 进课前检查是否有课程权限接口
  • URL: {{localhost}}/boxfish-online-card/member/info/checkBasicCourseInfo?access_token={{token}}
  • Method: POST
  • RequestBody
{
    "courseId": "L3NoYXJlL3N2bi9MZXZlbCAyX0Z1bmN0aW9uMS8wMDEu5aaC5L2V6KGo6L6-4oCc5pep5LiK5aW94oCd77yfLnhsc3g"
}
  • ResponseBody
{
    "status": "ERROR",
    "type": "TO_PAY",
    "message": "您没有购买此年级的教材版本。"
}

status = 'SUCCESS'，学生有权限；status = 'ERROR'，没有权限
type = 'type'，没有购买该课程

9. 【页面接口 for 旺旺】学生在网页领取福利接口
  • URL: {{localhost}}/boxfish-online-card/member/register/submitWelfareType?access_token={{token}}
  • Method: POST
  • RequestBody
{
    "welfareTypeList": [
        "BASIC_TEXTBOOK_V1_KNOWLEDGE",
        "BASIC_TEXTBOOK_V2_WORD",
        "ADVANCED_PAPER_V1_DEMO_V2",
        "INTERNATIONAL_25_MIN_COURSE"
    ]
}

"welfareTypeList"为枚举类型，枚举值为：
BASIC_TEXTBOOK_V1_WORD, // basic部分 1学期basic单词课
BASIC_TEXTBOOK_V1_KNOWLEDGE, // basic部分 教材同步单词课 2课
BASIC_TEXTBOOK_V2_WORD, // basic部分 1学期的四会课
ADVANCED_PAPER_V1_DEMO_V2, // 免费体验"体验小学期"，2节小班课 + 4节"外教1对1语言点纠正课"
INTERNATIONAL_25_MIN_COURSE; // 免费体验1节"1对1探究式外教课堂"，25min国际班外教1对1

10. 【APP接口】APP获取视频资源
  • URL: {{localhost}}/boxfish-wudaokou-user/ticket/BOXFISH_RESOURCE_VIDEO?access_token=l1RaF90wsf
  • Method: GET

实际返回数据以接口为准

11. 【APP接口】APP获取图片资源
  • URL: {{localhost}}/boxfish-wudaokou-user/ticket/BOXFISH_RESOURCE_IMAGE?access_token=l1RaF90wsf
  • Method: GET

实际返回数据以接口为准

12. 【APP接口】首页三件套接口增加参数
  • URL: {{localhost}}/boxfish-wudaokou-paper/paper/ai/getPaperSummary?access_token=oWUfnKV2ju&appIsNewVersion=true

  • Method: POST

  • RequestBody

    {
"appIsAdvancedPaper":"true"
}

  • ResponseBody

{
    "paperGradeIsPublic": false,
    "title": "听说读写综合学练",
    "sectionList": [
        {
            "typeDesc": "智能单词课",
            "courseTypeV3": "WORD",
            "amountCourse": 20,
            "amountFresh": 0,
            "courseName": "初中九年级下核心单词1",
            "courseCover": "1edd60a0b61a0a2e50639ab2625ed4a5",
            "nationalKnowledge": []
        },
        {
            "typeDesc": "语言点智能学习课",
            "courseTypeV3": "KNOWLEDGE",
            "amountCourse": 48,
            "amountFresh": 0,
            "courseName": "如何表达“一方面...另一方面...”？",
            "courseCover": "282ac93b640647c0562f6d764a30ade5",
            "nationalKnowledge": []
        }
    ]
}

paperGradeIsPublic: false 标识当年年级没有三件套，true 标识当前学期有三件套课程

13. 【APP接口】APP获取小班课接口
  • URL: {{localhost}}/boxfish-online-card/classOpen/student/getScheduleAssembleByStudentId?access_token={{token}}
  • Method: GET

返回体新增加两个参数：

private Boolean flagClassFinished_XXQ; // 小学期是否结业 private Boolean flagClassFinished_XBK; // 小班课是否结业

14. 【网页接口 for 旺旺】学生保存收货地址信息接口
  • URL: {{localhost}}/boxfish-online-card/member/info/saveUserAddress?access_token={{token}}

  • Method: POST

  • RequestBody

{
    "orderName": "test-hyd",
    "orderMobile": "18388880000",
    "orderProvince": "北京市",
    "orderCity": "北京市",
    "orderCounty": "朝阳区",
    "orderAddressDetail": "太阳宫"
}
15. 【APP接口】老用户领取礼包接口
  • URL: {{localhost}}/boxfish-online-card/member/info/submitWelfare?access_token={{access_token}}

  • Method: POST

  • RequestBody

{
    "userHasPaid":true
}

{
    "userHasPaid":false,
    "welfareSummaryList": [
        {
            "type": "BASIC_WORD",
            "orderIndex": 1,
            "videoUrl": "https://assets.boxfish.cn/v/video_word4.mp4",
            "videoCover_PAD": "https://avatars.boxfish.cn/app_resources/welfare_video_cover_textbook_word_ipad.png",
            "videoCover_PHONE": "https://avatars.boxfish.cn/app_resources/welfare_video_cover_textbook_word_iphone.png",
            "welfareTitle": "智能四会单词课",
            "welfareDescList": [
                {
                    "welfareUnit": "1学期",
                    "welfareDesc": "智能四会单词课"
                }
            ]
        },
        {
            "type": "ADVANCED",
            "orderIndex": 3,
            "videoUrl": "https://assets.boxfish.cn/v/video_innovation.mp4",
            "videoCover_PAD": "https://avatars.boxfish.cn/app_resources/welfare_video_cover_harvard_ipad.png",
            "videoCover_PHONE": "https://avatars.boxfish.cn/app_resources/welfare_video_cover_harvard_iphone.png",
            "welfareTitle": "精华小学期",
            "welfareDescList": [
                {
                    "welfareUnit": "4节",
                    "welfareDesc": "语言点智能学练课"
                },
                {
                    "welfareUnit": "2节",
                    "welfareDesc": "中外教翻转小班课"
                }
            ]
        }
    ]
}