文档中心

广西和教育开放平台支持内容型产品接入、智能硬件接入

• 内容型产品接入

  内容型产品可以通过多种形式入驻广西和教育平台，支持从平台获取用户参数，实现从和教育平台端导入用户资料。

  支持按以下形式接入：

  H5：内容型产品通过Html5网页格式，接入广西和教育移动客户端，用户从客户端访问应用页面。

  APP：内容型产品以手机应用APP形式运营，通过在广西和教育移动客户端获取用户身份信息，引导用户从广西和教育移动客户端跳转至应用APP。

  WEB：内容型产品通过网页资源形式，接入广西和教育网页端，用户从WEB个人中心访问应用网页。

  支持从平台接口获取以下信息：

  个人信息：获取登录用户在教育云平台用户中心的个人账户信息。包括手机号码、昵称、关联孩子名称、性别、头像照片等。

  班级信息：获取登录用户在教育云平台用户中心的关联班级信息，包括教师身份用户所管理的班级，家长身份用户关联的孩子所在班级。

  成员列表：获取登录用户在教育云平台用户中心的组织列表，包括信息用户群组。

  考勤信息：例如学生考勤卡，教师考勤卡基本信息，考勤人脸识别头像等。

• 智能硬件接入

  智能硬件可以使用开放平台提供的各种服务，支持与智能设备对接，提供安防数据透传、智能设备接入、考勤服务等接口。支持不同类型具备设备功能，可按设备拥有不同的接口权限。

  常用接口如下：

  人员同步接口：支持同步人员数据，包括人员标识、人脸头像等。

  考勤短信接口：调用用户中心的考勤模板短信接口发送考勤短信。

  人脸头像接口：支持上传人脸抓拍图片接口。

  亲情电话接口：获取学生绑定的亲情电话号码。

  温度接口：支持上传体温。

  通行规则同步接口：用于设置默认、特殊通行规则。

  人员设备绑定接口：实现人员与设备权限绑定。

  对于符合标准的介入硬件，广西和教育平台提供统一管理界面，对于非标准硬件产品，支持单点登录使用合作方的应用平台。

开放OpenAPI说明

OpenAPI是教育云平台对外开放的后台接口的统称，OPEAPI接口主要分为用户信息类、计费信息类、信息通讯类，具体哪个接口能够开发给指定的第三方应用使用，需要移动授权。

• 请求URL说明

  http://[域名]/[api_name]

  api_name说明：

  [api_name]：例如接口名称为：/ucenter/user/get_user_info

  请求参数access token和open_id必须通过appkey作为密钥加密

• OpenAPI超时时间说明

  OpenAPI接口机设置的最长超时时间为3s

  开发者可以根据上述说明自行设置OpenAPI调用的超时时间

• 返回数据说明

  所有返回的数据均通过分配给各应用的appkey作为密钥加密

• IP地址鉴权

  请求OpenAPI限制指定IP进行访问

• OpenAPI接口地址

  测试环境IP与端口：http://gxtest.linkageinfo.com/

  正式环境IP与端口：http://211.138.251.204:9091/

  http://hjy.gx.chinamobile.com:9091/

用户信息类接口

个人信息接口

• 接口说明：

  例如获取登录用户在教育云平台用户中心的个人账户的信息。包括邮箱，手机号码和昵称等。

  scope：get_user_info

• 接口地址：

  http://IP:PORT/educloud/api/openAPI/v3/get_user_info

• 接口参数说明：

  1．请求方法:POST

  2．请求参数

  参数	约束	说明
  access_token	必填	用户在应用中的access_token, 再以appkey作为密钥加密，加密算法参考附录1.4.1
  open_id	必填	用户在应用中的openid, 再以appkey作为密钥加密，加密算法参考附录1.4.1
  client_id	必填	应用接入获取的appId
  format	必填	如不填，返回json格式数据，目前只支持json
  state	必填	一个随机数
  sig	必填	请求串的签名，以appkey作为密钥。详见附录

  3．返回参数说明

  参数	约束	类型	说明
  ret	√	long	结果（0-成功；其他-失败）
  msg	√	String	相关描述，失败后的提示
  userInfo（返回用户信息对象）用户信息对象数据格式如下
  userId	√	long	用户ID
  openId	√	String	用户在这个应用的openID
  nickName	√	String	昵称
  birthday	√	String	生日，格式yyyy-mm-dd
  picture	√	String	头像(全路径)
  userType	√	int	1：教师，3：家长。即是老师又是家长，该字段默认传1。注：该字段不代表用户登录APP的身份，如需获取用户登录APP身份，通过接口1.3 和教育客户端内应用接入appToken与userType定义获取。
  remoteId	√	long	旧有校讯通中的教师ID
  remoteParentId		long	旧有校讯通中的家长ID
  remoteParentId		long	旧有校讯通中的家长ID
  updateTime	√	String	最后更新时间，格式：yyyy-MM-dd HH:mm:ss
  studentData，如果是家长，返回学生对象列表，数据格式如下
  userId		long	学生ID
  studentName		String	学生姓名
  sex		int	1:男，2:女
  birthday		String	生日，格式yyyy-mm-dd
  kindred		int	亲情关系，0：母亲，1：父亲，2：祖父母，3：其他关系
  updateTime		String	学生的最后更新时间，格式：yyyy-MM-dd HH:mm:ss
  classId		long	学生所在班级ID

  4．返回参数示例

  

班级信息

• 接口说明：

  例如获取登录用户在教育云平台用户中心的所在的班级信息，老师包括管理的班级、学生为所在班级、家长包括其孩子所在班级。

  scope：get_user_class_info

• 接口地址：

  http://IP:PORT/educloud/api/openAPI/v2/get_user_class_info

• 接口参数说明：

  1．请求方法:POST

  2．请求参数

  参数	约束	说明
  access_token	必填	用户在应用中的access_token, 再以appkey作为密钥加密，加密算法参考附录1.4.1
  open_id	必填	用户在应用中的openid, 再以appkey作为密钥加密，加密算法参考附录1.4.1
  client_id	必填	应用接入获取的appId
  format	必填	如不填，返回json格式数据，目前只支持json
  state	必填	一个随机数
  sig	必填	请求串的签名，以appkey作为密钥。详见附录

  3．返回参数示例

  参数	必选	类型	说明
  ret	√	long	结果（0-成功；其他-失败）
  msg	√	String	相关描述，失败后的提示
  classList（返回对象集合，包括多个班级对象）班级对象数据格式如下
  schoolId	√	long	学校id
  schoolName	√	String	学校名
  province	√	String	省id
  city	√	String	地市id，参见地市区县列表
  county	√	String	区县id，参见地市区县列表
  gradeId	√	long	年级id
  gradeName	√	String	年级名称（自定义）
  gradeType	√	String	年级类型（标准年级名称），参见标准年级列表
  classId	√	long	班级id
  className	√	String	班级名称
  classLogo		String	班级Logo,没有为空
  manageType	√	int	0: 非管理员，1:管理员
  type	√	int	1:教师，2:学生，3:家长
  updateTime	√	String	最后更新时间，格式：yyyy-MM-dd HH:mm:ss

  

成员列表

• 接口说明：

  例如获取登录用户在教育云平台用户中心的组织列表。

  scope：get_class_member_list

• 接口地址：

  http://IP:PORT/educloud/api/openAPI/v2/get_class_member_list

• 接口参数说明：

  1．请求方法:POST

  2．请求参数

  参数	约束	说明
  access_token	必填	用户在应用中的access_token, 再以appkey作为密钥加密，加密算法参考附录1.4.1
  open_id	必填	用户在应用中的openid, 再以appkey作为密钥加密，加密算法参考附录1.4.1
  client_id	必填	应用接入获取的appId
  class_id	必填	班级ID
  format	必填	如不填，返回json格式数据，目前只支持json
  state	必填	一个随机数
  sig	必填	请求串的签名，以appkey作为密钥。详见附录

  3．返回参数示例

  参数	必选	类型	说明
  ret	√	long	结果（0-成功；其他-失败）
  msg	√	String	相关描述，失败后的提示
  memberList（返回对象集合，包括多个成员对象）成员对象数据格式如下
  openId	√	long	用户ID
  nickName	√	String	昵称
  birthday	√	String	生日，格式yyyy-mm-dd
  picture	√	String	头像(全路径)
  sex	√	int	1:男，2:女
  manageType	√	int	0: 非管理员，1:管理员
  userType	√	int	1:教师，2:学生，3:家长
  updateTime	√	String	最后更新时间，格式：yyyy-MM-dd HH:mm:ss
  parentData，如果是学生，返回家长对象列表，数据格式如下
  openId		long	家长ID
  nickName		String	昵称
  picture		String	头像(全路径)
  sex		int	1:男，2:女
  email		String	邮箱
  birthday		String	生日，格式yyyy-mm-dd
  kindred		int	亲情关系，0：母亲，1：父亲，2：祖父母，3：其他关系
  updateTime		String	最后更新时间，格式：yyyy-MM-dd HH:mm:ss

  

成员列表(带手机号码)

• 接口说明：

  例如获取登录用户在教育云平台用户中心的成员列表，会返回对应的手机号码，各应用默认无权限请求，需要向局方申请。

  scope：get_class_member_with_phone_list

• 接口地址：

  http://IP:PORT/educloud/api/openAPI/v2/get_class_member_with_phone_list

• 接口参数说明：

  1．请求方法:POST

  2．请求参数

  参数	约束	说明
  access_token	必填	用户在应用中的access_token, 再以appkey作为密钥加密，加密算法参考附录1.4.1
  open_id	必填	用户在应用中的openid, 再以appkey作为密钥加密，加密算法参考附录1.4.1
  client_id	必填	应用接入获取的appId
  class_id	必填	班级ID
  format	必填	如不填，返回json格式数据，目前只支持json
  state	必填	一个随机数
  sig	必填	请求串的签名，以appkey作为密钥。详见附录

  3．返回参数示例

  参数	必选	类型	说明
  ret	√	long	结果（0-成功；其他-失败）
  msg	√	String	相关描述，失败后的提示
  memberList（返回对象集合，包括多个成员对象）成员对象数据格式如下
  userId	√	long	用户中心的用户ID
  nickName	√	String	昵称
  birthday	√	String	生日，格式yyyy-mm-dd
  picture	√	String	头像(全路径)
  sex	√	int	1:男，2:女
  manageType	√	int	0: 非管理员，1:管理员
  userType	√	int	1:教师，2:学生，3:家长
  updateTime	√	String	最后更新时间，格式：yyyy-MM-dd HH:mm:ss
  phone		String	教师有手机号码则填，学生不填，家长填手机号码
  parentData，如果是学生，返回家长对象列表，数据格式如下
  userId		long	用户中心的家长ID
  nickName		String	昵称
  picture		String	头像(全路径)
  sex		int	1:男，2:女
  email		String	邮箱
  birthday		String	生日，格式yyyy-mm-dd
  kindred		int	亲情关系，0：母亲，1：父亲，2：祖父母，3：其他关系
  updateTime		String	最后更新时间，格式：yyyy-MM-dd HH:mm:ss
  phone		String	家长手机号码

  

个人信息(带手机号码)

• 接口说明：

  例如获取登录用户在教育云平台用户中心的个人账户的信息，会返回对应的手机号码，各应用默认无权限请求，需要向局方申请。

  scope：get_user_info_with_phone_list

• 接口地址：

  http://IP:PORT/educloud/api/openAPI/v2/get_user_info_with_phone_list

• 接口参数说明：

  1．请求方法:POST

  2．请求参数

  参数	约束	说明
  access_token	必填	用户在应用中的access_token, 再以appkey作为密钥加密，加密算法参考附录1.4.1
  open_id	必填	用户在应用中的openid, 再以appkey作为密钥加密，加密算法参考附录1.4.1
  client_id	必填	应用接入获取的appId
  format	必填	如不填，返回json格式数据，目前只支持json
  state	必填	一个随机数
  sig	必填	请求串的签名，以appkey作为密钥。详见附录

  3．返回参数示例

  参数	必选	类型	说明
  ret	√	long	结果（0-成功；其他-失败）
  msg	√	String	相关描述，失败后的提示
  userInfo（返回用户信息对象）用户信息对象数据格式如下
  userId	√	long	用户中心的用户ID
  nickName	√	String	昵称
  birthday	√	String	生日，格式yyyy-mm-dd
  picture	√	String	头像(全路径)
  sex	√	int	1:男，2:女
  userType	√	int	1：教师，3：家长。即是老师又是家长，该字段默认传1。注：该字段不代表用户登录APP的身份，如需获取用户登录APP身份，通过接口1.3 和教育客户端内应用接入appToken与userType定义获取。
  updateTime	√	String	最后更新时间，格式：yyyy-MM-dd HH:mm:ss
  phone		String	教师有手机号码则填，学生不填，家长填手机号码
  extendInfo（返回用户的扩展信息），这是一个对象列表，目前列表中包含如下字段，未来可能增加字段
  userId		long	用户中心的家长ID
  roleType		int	教师的角色类型：0：普通老师，1：班主任，2：年级组长，3：校级角色
  roleId		int	教师角色id
  roleName		String	教师角色名称
  orgId		long	教师角色类型对应的组织id，如校长对应学校id，班主任对应班级id
  schoolId		long	教师对应的学校id
  studentData，如果是家长，返回学生对象列表，数据格式如下
  userId		long	用户中心的学生ID
  studentName		String	学生姓名
  sex		int	1:男，2:女
  birthday		String	生日，格式yyyy-mm-dd
  kindred		int	亲情关系，0：母亲，1：父亲，2：祖父母，3：其他关系
  updateTime		String	最后更新时间，格式：yyyy-MM-dd HH:mm:ss
  classId		long	学生所在班级ID

  4.返回参数示例

  教师示例

  

  家长示例

  

计费类接口

订购结果查询接口

• 接口说明：

  通过该接口调用用户中心的订购结果查询接口进行查询是否订购成功

  scope：fee_query：

• 接口地址：

  http://IP:PORT/educloud/api/openAPI/fee/fee_query

• 接口参数说明：

  1．请求方法:POST

  2．请求参数

  参数	约束	说明
  access_token	必填	用户（发送人）在应用中的access_token, 再以appkey作为密钥加密，加密算法参考附录1.4.1
  open_id	必填	用户（发送人）在应用中的openid, 再以appkey作为密钥加密，加密算法参考附录1.4.1
  client_id	必填	应用接入获取的appId
  format	必填	如不填，返回json格式数据，目前只支持json
  fee_type	必填	计费类型，0：点播，1：包月
  serial_no		点播流水号，多个可用逗号分隔（目前点播仅支持按流水号查询）
  service_code		包月的业务代码，多个可用逗号分隔（目前包月仅支持按业务代码查询）
  state	必填	一个随机数
  sig	必填	请求串的签名，以appkey作为密钥。详见附录

  3.返回参数说明：

  参数	必选	类型	说明
  ret	√	long	结果（0-成功；其他-失败）
  msg	√	String	相关描述，失败后的提示
  rights	√	String	个人权益，4：教师A类，5：教师B类，1：家长A类，2：家长B类，3：家长C类；如果既是老师又是家长，则以英文逗号分隔返回教师和家长的权益，例如：1,3
  consumptions	点播信息，包括多条点播的结果，这是一个对象列表，目前列表中包含如下字段，未来可能增加字段，如果是查询包月这个列表为空
  serialNo		String	点播流水号
  feeDn		String	计费号码，中间4位用*替换
  serviceCode		String	业务代码
  result		long	点播结果，0：成功，其他-失败
  resultDesc		String	点播结果描述，可能为空
  dealTime		String	点播成功时间，格式：yyyy-MM-dd HH:mm:ss
  billings	包月信息，包括多条包月业务的结果，这是一个对象列表，目前列表中包含如下字段，未来可能增加字段，如果是查询点播这个列表为空
  serviceCode		String	包月业务代码
  feeDn		String	计费号码，中间4位用*替换
  state		int	包月业务状态，目前都是1：已订购
  bookTime		String	订购成功时间，格式：yyyy-MM-dd HH:mm:ss

  4.返回参数示例：

  点播示例:

  

  包月示例:

  

客户端能力开放接口

和校园APP提供给第三方H5应用调用的底层能力开放相关接口。第三方H5应用可以通过JavaScript调用相关的接口

扫描二维码接口

• 接口说明：

  第三方H5应用可通过JavaScript调用该接口实现在和校园APP里调用扫描二维码功能，和校园APP会返回给第三方二维码的扫描结果

• 接口地址：

  openScanFunc0()

• 接口参数说明

  1．请求方法: JavaScript调用

  2．请求参数

  参数	约束	说明
  returnJs	必填	二维码扫描完之后要回调的JavaScript方法名，第三方的H5应用需要实现这个方法

  3.回调参数说明

  参数	必选	类型	说明
  content	√	String	二维码扫描成功之后回调第三方H5应用提供的returnJs（content）传的参数

  4.JS调用示例

  

拨打电话接口

• 接口说明：

  第三方H5应用可通过JavaScript调用该接口实现在和校园APP里调用拨打电话功能，和校园APP会拉起手机的拨打电话功能

• 接口地址：

  callHtmlPhone()

• 接口参数说明

  1．请求方法: JavaScript调用

  2．请求参数

  参数	约束	说明
  phone	必填	要拨打的手机号码

  3.JS调用示例

  

关闭H5页面接口

• 接口说明：

  前端通过调用js调用此方法来达到关闭页面的效果。

• 接口地址：

  finishWebview()

• 接口参数说明

  1．请求方法: JavaScript调用

  2．请求参数:

  3.JS调用示例

  

修改客户端导航栏的标题接口

• 接口说明：

  前端通过调用此方法可以修改客户端导航栏的显示标题。

• 接口地址：

  modifyH5Title()

• 接口参数说明

  1．请求方法: JavaScript调用

  2．请求参数:

  参数	约束	说明
  标题名称	必填	标题名称
  0	必填	0不显示 1显示默认传0

  3.JS调用示例

  

上传图片接口

• 接口说明：

  前端通过调用此方法可以上传附件并获取一个图片的url地址

• 接口地址：

  h5UploadFile0()

• 接口参数说明

  1．请求方法: JavaScript调用

  2．请求参数:

  参数	约束	说明
  0	必填	附件类型 0:图片
  0	必填	是否更新头像 默认传0
  	选填	扩展字段json字符串 没有传空

  3.JS调用示例

  
• 回调参数说明

  客户端在上传图片成功后会回调js方法并带入两个参数

  方法名:refreshUploadMethod

  参数:

  1.图片url地址

  2.接口返回json字符串透传给前端

隐藏客户端标题栏接口

• 接口说明：

  前端通过调用此方法可以隐藏客户端标题栏

• 接口地址：

  hideH5Title00()

• 接口参数说明

  1．请求方法: JavaScript调用

  2．请求参数:

  参数	约束	说明
  0或1	必填	是否隐藏标题栏 0:隐藏 1:显示

  3.JS调用示例

  

拍摄视频接口

• 接口说明：

  前端通过调用此方法可以拍摄视频时间为10秒以内

• 接口地址：

  H5ShootVideo0()

• 接口参数说明

  1．请求方法: JavaScript调用

  2．请求参数:无

  3.JS调用示例

  

  4.回调:

  视频上传后通过js方法refreshUploadMethod('参数一:视频url地址 ','参数二:接口返回的扩展json字符串')回调给h5页面

网络状态接口

• 接口说明：

  前端通过调用此方法可以检查当前网络状态

• 接口地址：

  CheckNetwork0()

• 接口参数说明

  1．请求方法: JavaScript调用

  2．请求参数:无

  3.JS调用示例

  

  4.回调:

  获取网络状态后通过js方法networkStateCallBack('参数一:网络状态') 回调给h5页面。

位置信息接口

• 接口说明：

  前端通过调用此方法可以获取位置信息

• 接口地址：

  H5GetGpsIndo0()

• 接口参数说明

  1．请求方法: JavaScript调用

  2．请求参数:无

  3.JS调用示例

  

  4.回调:

  获取位置信息后通过js方法locationInfoCallBack('参数一:经度,纬度','参数二:位置信息') 回调给h5页面

语音接口

• 接口说明：

  前端通过调用此方法可以录音

• 接口地址：

  recordFromJSM()

• 接口参数说明

  1．请求方法: JavaScript调用

  2．请求参数:无

  3.JS调用示例

  

  4.回调:

  语音上传后通过参数一的js方法('参数一:音频url地址')回调给h5页面