API列表

  • 用户基本信息

    接口地址: http://openapi.weike.wanpeng.com/user/userInfo.json

    调用参数

    参数名 参数值 是否必填 说明
    token 微课用户唯一标识 String,从微课跳转到应用时获得
    appId 第三方应用id String,应用注册后分配
    salt 时间戳 long,到毫秒
    securityKey 加密串 String,授权登录:计算方式:md5(accessToken +salt+app约定串) 非授权登录:计算方式:md5(token原始值+salt+app约定串)
    needClass 是否同时返回用户所在班级信息 int,1:是, 0:否,默认0

    返回数据属性

    属性名 参数名 数据类型 是否可为空 说明
    code 成功失败信息 String 参考具体编号说明
    message 返回信息描述 String 格式:"Success"
    userInfo{} 用户对象 {} 包含下面属性
    userInfo.openId 用户id String
    userInfo.name 真实姓名 String
    userInfo.ownerType 角色 String 1学生2教师3家长
    userInfo.avatarUrl 头像地址 String userInfo里属性,格式: http://file.wanpeng.com/a.png
    userInfo.schoolId 学校id String
    classList{} 所属班级信息 String
    classList.id 班级id String
    classList.name 班级名称 String
    classList.acadyear 入学年份 String "2014-2015"
    classList.schoolId 学校id String
    classList.section 学段 String 0:幼儿园 1:小学 2:初中 3:高中
  • 用户扩展信息

    接口地址: http://openapi.weike.wanpeng.com/user/userMoreInfo.json

    调用参数

    参数名 参数值 是否必填 说明
    token 微课用户唯一标识 String,从微课跳转到应用时获得
    appId 第三方应用id String,应用注册后分配
    salt 时间戳 long,到毫秒
    securityKey 加密串 String,授权登录:计算方式:md5(accessToken +salt+app约定串) 非授权登录:计算方式:md5(token原始值+salt+app约定串)

    返回数据属性

    属性名 参数名 数据类型 是否可为空 说明
    code 成功失败信息 String 参考具体编号说明
    message 返回信息描述 String 格式:"Success"
    classList{} 所属班级信息 String 身份为老师时返回
    classList.id 班级id String
    classList.name 班级名称 String
    classList.acadyear 入学年份 String "2014-2015"
    classList.schoolId 学校id String
    classList.section 学段 String 0:幼儿园 1:小学 2:初中 3:高中
    classList.graduate 是否已毕业 String 0:未毕业, 1:已毕业
  • 班级成员

    接口地址: http://openapi.weike.wanpeng.com/user/classMember.json

    调用参数

    参数名 参数值 是否必填 说明
    token 微课用户唯一标识 String,从微课跳转到应用时获得
    appId 第三方应用id String,应用注册后分配
    salt 时间戳 long,到毫秒
    securityKey 加密串 String,授权登录:计算方式:md5(accessToken +salt+app约定串) 非授权登录:计算方式:md5(token原始值+salt+app约定串)
    classId 班级id
    ownerType 角色 1学生 2教师

    数据属性

    属性名 参数名 数据类型 是否可为空 说明
    code 成功失败信息 String 参考具体编号说明
    message 返回信息描述 String 格式:"Success"
    familyList{} 家庭成员 list 家庭列表,只有ownerType是1的情况下返回
    familyList.childName 孩子姓名 String
    familyList.childOpenId 每个家庭的孩子的openId String
    familyList.parentList 每个家庭的孩子的家长信息 list
    familyList.parentList.parentOpenId 家长OpenId String
    familyList.parentList.parentRealName 家长姓名 String
    teacherList{} 班级老师列表 list 班级老师列表,只有ownerType是2的情况下返回
    teacherList.openId 老师openId String
    teacherList.realName 老师姓名 String
  • 学校信息

    接口地址: http://openapi.weike.wanpeng.com/user/schoolInfo.json

    调用参数

    参数名 参数值 是否必填 说明
    token 微课用户唯一标识 String,从微课跳转到应用时获得
    appId 第三方应用id String,应用注册后分配
    salt 时间戳 long,到毫秒
    securityKey 加密串 String,授权登录:计算方式:md5(accessToken +salt+app约定串) 非授权登录:计算方式:md5(token原始值+salt+app约定串)
    schoolId 单位id 学校id或教育局id

    数据属性

    属性名 参数名 数据类型 是否可为空 说明
    code 成功失败信息 String 参考具体编号说明
    message 返回信息描述 String 格式:"Success"
    schoolInfo{} 基本信息对象 json
    schoolInfo.id 单位id String
    schoolInfo.regionCode 单位行政区划编号 String 参考国家的行政区划
    schoolInfo.schoolName 单位名称 String
  • 分享数据到班级圈

    接口地址: http://openapi.weike.wanpeng.com/share/group_share.json

    调用参数

    参数名 参数值 是否必填 说明
    appId 应用id
    groupIds 分享到的班级 格式:"A,B",多个班级间逗号隔开
    key 安全校验码 md5(约定串+时间戳)+时间戳
    userId 分享者id
    shareType 分享类型 格式:7:网页,6:文档
    title 分享过来的链接标题
    linkUrl 链接地址
    docName 文档名称

    数据属性

    属性名 参数名 数据类型 是否可为空 说明
    code 成功失败信息 String 参考具体编号说明
    message 返回信息描述 String 格式:"Success"
  • 应用消息提醒

    接口地址: http://openapi.weike.wanpeng.com/publicPush/personalPush.json

    调用参数

    参数名 参数值 是否必填 说明
    appId 应用id
    publicId 公众号id
    auth 加密算法 加密串,规则:Md5(约定字符串+时间戳)+时间戳 注意:约定字符串由微课掌上通平台提供
    userIdentity 用户标识类型 1、token或openId 2、微课userId 3、数字校园userid
    jumpType 跳转类型 int 0:跳h5页面 1:跳原生
    userJsonStr 与用户标识类型对应json 与用户标识类型对应:json格式 ['uid1','uid2','uid3'......]
    isNeedHead 推送内容是否需要头部 int (1.是 0.否)
    isNeedFoot 推送内容是否需要尾部 int (1.是 0.否)
    head 头部内容 注意:需urlEncode(‘utf-8’)
    body 主体部分内容 string,注意:需urlEncode(‘utf-8’)
    foot 尾部内容 string,注意:需urlEncode(‘utf-8’)
    msgTitle 微课消息页展示内容 string,注意:需urlEncode(‘utf-8’)
    url 推送内容的链接地址 string,注意:需urlEncode(‘utf-8’)
    code 所要跳转原生页面的code string,当jumpType=1时,此字段必填,具体对应的值,双方约定好即可
    ext 额外的配置 string,当jumpType=1时,所需的参数,以及一些额外的配置,都通过此字段传过来,双方约定好即可。注意:需urlEncode(‘utf-8’)

    数据属性

    属性名 参数名 数据类型 是否可为空 说明
    code 成功失败信息 String 参考具体编号说明
    message 返回信息描述 String 格式:"Success"