API概述

日期: 2021-03-02

创盛视联数码科技（北京）有限公司

[TOC]

API简介

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

调用方式

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

请求结构

接口URL

 详见具体接口说明

通信协议

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

请求方法

 具体支持的HTTP方式, 详见具体接口说明
 GET方式查询字符串（名称/值对）是在GET请求的URL中发送的，
 POST方式查询字符串（名称/值对）是在POST请求的HTTP消息主体中发送的，格式为application/json

字符编码

请使用UTF-8编码

签名机制

接口需要采用THQS加密，具体加密规则，详见 https://doc.bokecc.com/class/developer/api/thqs.html

返回结果

返回值

所有返回值一律为JSON格式，返回的接口字段result字段为OK，代表调用成功。返回FAIL代表调用失败。
形如： {"result": "OK", "data": ****}

成功结果示例

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

错误结果示例

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

完整错误码，错误码说明

名词解释: 开发者账号ID 该名词对应客户开通CC服务的账号ID