跳到主要内容

附录：EEO系统和对接基本概念

EEO 系统概述​

EEO 提供一个实时在线教室系统及相关服务。 系统主要包含两部分：

  • 客户端产品：产品名为 ClassIn，支持 Windows 和 Mac OS 、iOS 、 Android 移动端平台。
  • 基于 Web 的后台管理系统，访问网址为 www.eeo.cn。

ClassIn 概述​

ClassIn 是一个客户端应用程序，面对老师和学生，需要安装后使用。提供各种班型的实时在线课堂以及各种学习活动。标准API对接并不涉及对客户端功能和行为的改变。

eeo.cn 概述​

基于 Web 的后台管理系统，机构可以使用这个系统来进行课程、课节的管理，老师、学生、旁听的设置，上课数据的收集与展示，实时监课的管理云盘、课件的管理等。 另外 eeo.cn 支持 API 对接，使得机构可以自行开发更加适合自身业务逻辑的管理系统，替代eeo.cn后台的功能。

eeo.cn 的 API 对接说明​

在对接之前，需要先对两个系统的业务逻辑进行匹配，然后才对设计相应的功能。文档这一部分介绍了eeo系统的一些基本概念，包括学生老师和课程的组织方式。

基本概念​

身份相关（用户、老师、学生、旁听、机构、子帐号等）​

  • EEO 的系统是一个强帐号系统，每个人都需要有一个用户帐号。
  • 用户必须登陆 ClassIn 或者 eeo.cn 才能使用各项业务功能。
  • 机构需要将某些用户添加为机构老师，才能在设置课程、课节的时候将机构老师指定为本课程、课节的老师。
  • 学生、旁听等都是针对课程或课节而言的一种身份。一个用户可以在某节课下为老师，同时也可以在其他课程或课节下是学生或其他身份。
  • 任何用户都可以被指定为课程、课节下的学生（机构账号不可以指定为学生）。
  • 旁听只能针对课程来设置。
  • 任何用户在一个课节下只能具有一种身份。
  • 机构帐号就是经过机构认证后的用户。机构帐号具备添加机构老师、创建课程、指定子帐号等功能。
  • 子帐号是机构用来指定多名管理人员的，eeo.cn 后台支持机构配置多个子帐号，并且可以为每个子帐号指定不同的权限。子帐号设置暂时不支持通过 API 设置。
  • 具有监课权限的子帐号可以通过Web链接唤起客户端的形式，以旁听身份进入机构下的任何课节。

课程相关（课程、课节）​

  • EEO 的系统对课程的管理分为两个层级。第一层是课程，第二层是课节。
  • 机构可以创建任意多个课程
  • 每个课程下可以有多个课节，建议多个课节不要有时间重叠。
  • 如果机构没有课程的概念，可以每个课程里面搭配创建一个课节来使用EEO的系统。

云盘相关​

  • EEO 为每个用户都创建了一个系统内部的云盘。
  • 云盘是目录（文件夹）结构的，每个目录下都可以创建多个目录和文件。目录的总数最大限制是5000个，目录深度最多是15级。
  • 目前云盘可以存放 PPT、Word、PDF、audio、video 等系统支持的课件类型。
  • 云盘里的课件支持在 ClassIn 的教室里打开使用。
  • 老师在上课时可以打开自己个人云盘里的任何系统支持的课件。
  • 经过机构认证后的用户的云盘，这里简称为机构云盘。
  • 机构可以为课程或课节指定一个机构云盘里的目录，老师在上这节课时，可以打开该目录下的任何系统支持的课件。

API 中的名词及关系​

  • 用户：ClassIn 是一个强帐号系统，所有的用户必须先登录，才能看到属于用户的相关课程信息，以及使用其他系统提供的各项功能。也因此所有的用户都需要有 EEO 的帐号。

  • 课程、课节：一个课程包含多个课节，不支持独立的课节，也就是必须先有课程，然后再课程下添加一个或多个课节。

  • 班级群：每创建一个标准课程时，系统会自动创建一个班级群（可以在 ClassIn IM 查看此群）。

  • 课程下的属性有：

    • 课程名称：会显示在 ClassIn 的界面上。为了便于管理，建议精心设计课程名称的命名规则。
    • 课程图片：会显示在 ClassIn 的界面上。该图片不支持修改。
    • 过期时间：每个课程都有一个截止日期，截止日期之后，系统将不再支持针对该课程的任何增、删、改等操作。如果没有设置该值，系统自动设置为该课程下最后一节课之后的90天。
    • 课程资源：EEO 系统支持机构为每个课程设置一个云盘目录（没有为课节节设置云盘目录），授课老师在该课程的上课过程中，可以访问、使用这个云盘目录下的所有可用课件。如果为单个课节设置了云盘目录，那么授课老师在该课节的上课过程中，将只能访问、使用该课节所设置的云盘目录。
    • 课程学生：逻辑和课程资源类似，课程学生可以进入该课程下的所有课节，后创建的课节也允许课程学生进入。课程下总学生人数，称之为班容。
    • 课程旁听：逻辑等同于课程学生。只是角色是旁听，老师、学生完全感知不到旁听存在。旁听可用来做家长兼课等用途。

  • 课节下的属性有：

    • 课节名称：会显示在 ClassIn 的界面上。为了便于管理，建议精心设计课节名称的命名规则。
    • 上下课时间：必须为每节课设置正确的起止时间。老师可以上课时间前20分钟进入教室，学生、旁听等可以提前10分钟进入。下课时间的20分钟后，系统会强制所有人退出教室。上课时间必须晚于当前时间。
    • 课节老师：因为同一套课程可能由多个老师来共同完成，所以老师是以课节为单位来设置的。课节开课前20分钟就不能再修改课节老师了。
    • 台上人数：教室内同时在台上的最大人数，例如1v6表示最多可上台1名教师和6名学生。
    • 课节学生：针对一些场景，如不同的课节下有不同的学生、或者调课等场景，需要针对课节配置可以进入的学生，那么就可以使用这个属性。课节学生是以课节为单位来设置的。

备注：

  • 如果您想调大以下三个参数值，您可以联系客户顾问：最大台上人数，课程学生最大人数（即班容），课程旁听生最大人数。

机构在做 API 对接时的主要工作​

注意：为了给您提供更好的产品和服务，系统会在每个季度末的第三个星期二凌晨（北京时间）进行例行维护，具体维护时间请访问以下链接。 https://docs.eeo.cn/product/zh-hans/function/System/Maintainance.html 请您在排课的时候，确保课节时间与系统维护时间没有重合。在系统维护期间的所有API请求，都会返回 901 的状态码。

对接用户​

  • 机构必须使用真实手机号来创建 EEO 的用户帐号（需要其他形式，请与商务人员联系咨询）
  • 把所有老师的用户帐号添加为机构老师（调用 API，或者在 eeo.cn 手工完成）
  • API 手册里有创建用户、修改密码、修改用户信息等接口

创建课程​

  • API 手册里有课程对应的增删改查接口
  • 为课程设置学生、旁听等用户（可选）
  • 为课程设置云盘资源（可选）

为指定课程创建课节​

  • API 手册里有课节对应的增删改查接口
  • 为课节设置老师、学生（可选）等用户

创建网页链接唤起客户端（可选）​

  • 有两种方式创建链接
  • 一种方法是根据底层API 获得必要信息，自行生成链接
  • 另一种方法是调用API 直接获得该链接

云盘资源管理（可选）​

  • API 手册里有云盘相关增删改查接口