如何对接直播云API服务?
在正式对接使用直播云API接口之前,需要提供鉴权接口给直播云(提供的接口标准下一小节详述)。在访问各端SDK时,需传入验签TOKEN和机构课节信息,我们在进入课堂中的时候,会将TOKEN原样请求上述验签接口。机构返回验签正确,即可自动课中各服务验证。
上图为对接机构使用直播云API流程,流程具体如下:
第三方机构以自己验签规则设置课节验签TOKEN;
第三方机构访问直播云SDK API,上传参数自己机构ID、TOKEN、课节ID以及业务相关参数;
直播云后台API收到第三方机构的HTTP请求,从请求参数中的机构ID找到该机构在直播云设置的验签地址;
访问机构对应的验签地址,请求参数包含用户上传的TOKEN和课节ID;
第三方机构接收到直播云的验签请求,根据自己的验签规则进行验签,返回验签成功或者失败,验签返回结果格式固定,详见下节SDK对接第三方提供验证用户token接口标准;
直播云后台API接收到第三方机构返回的验签结果,根据验签结果进行判断是否进行具体业务;
如果失败,直接返回失败,并在返回字段中提示验签失败;如果成功,则执行具体业务流程,返回成功。
SDK对接第三方提供验证用户TOEKN接口标准
验签需要第三方机构提供给我们验签地址,验签地址要求如下:
地址
****/check/token(由需要SDK对接的机构提供)
请求方式
POST - form提交
请求参数
参数名称 | 是否必填 | 参数含义 |
---|---|---|
token | 是 | 第三方token,有机构自己生成 |
lesson_id | 是 | 第三方课程id |
返回值
成功返回值
返回格式为JSON(Content-Type为application/json),JSON示例加说明
所有参数必需,注意true/false要加""{
"status": "true",
"time": "2017-04-10 16:12:14",
"data": "******"//具体数据
"msg":"succ"
}
失败返回值
返回格式为JSON,JSON示例加说明
{
"status": "false",
"time": "2017-04-10 16:12:14",
"data": "******"//具体数据
"msg":"调用失败"
}
判断返回值:status为"false"时,验证token失败,返回非"false"时,认为验证token成功,提供相应的服务。