接口认证相关API

优质
小牛编辑
128浏览
2023-12-01

接口认证相关

接口验证

— 概述

通过CC视频云课堂登录接口验证,客户的用户系统可对观看直播的用户进行鉴权
验证接口由客户进行开发,在学员登录时,由CC视频云课堂 将登录信息提交给该接口验证用户身份信息。
  • 接口地址
创建直播间时,验证方式选择接口验证并填写接口地址
例:老师端publisher_authtype为0 在publisherpass填写该接口地址
  • 请求方式
POST(Form表单)
  • 接口参数说明
参数名称参数类型参数说明备注
roomid字符串直播间id必须
viewername字符串登录用户名必须
viewertoken字符串登录密码必须
  • 返回数据格式

        {
          "result": "ok",       
          "message": "登录成功", # 可传可不传
          "user":{
              "id": "E6A232B2DEDF69469C33DC5901307461", # 用户对应的id
              "name': "学员A", # 用户名
              "avatar': "http://domain.com/icon.png", # 用户头像路径,可传可不传
          }
      }
    
  • 说明

 返回值应 以json形式返回
 返回值result表明验证是否通过,如果成功,客户应返回 'OK', 'ok', true', 'yes', 'YES',中的任一个,云平台将其他结果均认为验证失败,即不允许登录

 旁听接口验证仅支持返回'ok',互动者支持以上