有课API文档

#简介 有课开放api暂时只开放控制台能力，如有更多需求，请联系我们。申请api调用权限，请联系-- #名词解释 |词 |意| |---|---| |有课|有课平台| |用户| 有课系统中登录控制台，管理培训的角色| |观众|培训的受众| |培训|一次培训的直播间 #接入注意事项 -所有请求中都**必须包含`access_key`,`timestamp`,`sign`三个参数**，签名生成算法请见下文 |参|意| |---|---| |access_key|请求凭证| |timestamp|位时间戳(秒)，请求有效期为服务器时间| |sign|请求签名| -下文中所有大写单词，均指代请求时的实际值 -`access_key`均代表`access_key`的值 -`secret_key`均代表`secret_key`的值 -`timestamp`均代表`timestamp`的值 -`sign`均代表`sign`的值 -请使用`https`协议 #请求示例 >下面将用[控制台-培训-详情](https://postman.mudu.tv/#dcab--d-da-acbd)接口做简单示例，该接口需要`post`请求，且只有一个`id`参数 .获取请求地址`https://youke.mudu.tv/console/index.php?c=live&a=info` .在请求`body`中加入`id`参数 .在请求url中加入参数`access_key`,`timestamp`,`sign`，新的请求url为：`https://youke.mudu.tv/console/index.php?c=live&a=info&#;tamp=timestamp&access_key=access_key&sign=sign` .发送`post`请求 .返回值为json对象，`code`为返回状态码，xx为成功。`msg`为返回信息，`data`为返回数据，无数据返回时，会返回`null` ```json { "code":, "msg":"success", "data":{ "id":"nmjoqyhqybqpcoooglezcesmz", "account_id":, "name":"测试培训", "status":, "live_status":, "link_status":, "link_apply_status":, "stream":"uijtt", "stream_status":, "client_id":, "cover":"", "background":null, "created_at":"--::", "updated_at":"--::", "deleted_at":null, "will_start":"--::", "will_stop":"--::", "last_start":"--::", "last_stop":"--::", "comment_enable":, "media_id":, "watch_amount":, "white_list_num":, "attend_num":, "manager_id":null, "watch_mode":, "department_id":null, "issue_enable":, "ecdn_enable":, "type":, "interactive_room_id":"", "mrtc_addr":"", "doc_event_id":null } } ``` #请求签名算法 请求签名算法将以[控制台-培训-详情](https://postman.mudu.tv/#dcab--d-da-acbd)为示例说明。示例涉及代码，均以php实现，仅供参考。 .将所有psot和`access_key`,`timestamp`,`secret_key`合并到一维数组中,并将所有value转换为string类型 ```php array(size=) &#;access_key&#;=>string&#;access_key&#;(length=) &#;secret_key&#;=>string&#;secret_key&#;(length=) &#;timestamp&#;=>string&#;&#;(length=) &#;id&#;=>string&#;nmjoqyhqybqpcoooglezcesmz&#;(length=) ``` .将该数组根据key按照字典顺序排序 ```php array(size=) &#;access_key&#;=>string&#;access_key&#;(length=) &#;id&#;=>string&#;nmjoqyhqybqpcoooglezcesmz&#;(length=) &#;secret_key&#;=>string&#;secret_key&#;(length=) &#;timestamp&#;=>string&#;&#;(length=) ``` .将该数组转换为字符串，注意**不要**将中文编码为unicode ```json { "access_key":"access_key", "id":"nmjoqyhqybqpcoooglezcesmz", "secret_key":"secret_key", "timestamp":"" } ``` .sha算出签名 ``` ecfafaaeccfdce ``` #关于错误码的说明 目前全局错误码仅有下方所示几种，其余错误请结合错误信息判断。如有疑问，请联系我们。 |code|msg|说明| |---|---|---| ||frequencylimited.|请求频率限制，具体限制请参见频率限制一节| ||signerror.|签名错误| ||emptyparamortimestamperror|必传参数错误或传入时间戳和系统时间差距大于s| ||unknownerror|未知错误| #频率限制 单帐号次/分钟