API概述

更新时间：2022-12-28

API简介

API帮助开发者快速定制专属于您的课堂服务。依照提供的API接入文档， 您可以将云课堂与自身的业务模式进行集成，进而拥有课堂管理、直播发起、回放管理等功能。

调用方式

API调用主要是通过对接方向API的服务端地址发送HTTP GET/POST请求（具体HTTP请求方式以对应接口说明为准)， 并按照接口说明填写相应的请求参数完成的。服务端接收到请求后，系统会按照请求的处理情况，返回处理结果。

请求结构

接口URL

详见具体接口说明

通信协议

请求支持HTTP和HTTPS两种访问方式

请求方法

具体支持的HTTP方式, 详见具体接口说明。 GET请求方式参数（名称/值对）是在GET请求的URL中发送，POST请求方式参数是在请求的HTTP body消息体中发送， 格式为application/json，请求头需设置Content-Type为application/json。

字符编码

请使用UTF-8编码

签名机制

接口需要采用THQS加密，具体加密规则详见THQS说明

返回结果

返回值

所有返回值一律为JSON对象，返回字段一律包含result字段，result字段为OK，代表调用成功。返回FAIL代表调用失败。

例如： {"result": "OK", "data": **}或{"result": "OK"}。

说明：对于有详细数据返回时data字段不为空，无详细数据返回时为空，可能部分历史接口存在差异，具体详具体接口返回说明及示例。

成功结果示例

{
    "result": "OK",
    "data": {
        "user_id": 16417997
    }
}

{
    "result": "OK",
}

错误结果示例

{
    "result": "FAIL",
    "errorMsg": "服务请求错误",
    "error": {
       "code": 10,               //错误码
       "type": "ValidationError" //错误类型
    }
}

错误码说明跳转