{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"bbc708ea-1968-41b9-8f63-100eafcf31c2","name":"有课\bAPI文档","description":"# 简介\n有课开放API暂时只开放控制台能力，如有更多需求，请联系我们。申请API调用权限，请联系 4009-618-610\n\n# 名词解释\n\n| 词\t| 意 |\n| --- | --- |\n| 有课 | 有课平台 |\n| 用户 |\t有课系统中登录控制台，管理培训的角色|\n| 观众 | 培训的受众 |\n| 培训 | 一次培训的直播间\n\n\n# 接入注意事项\n- 所有请求中都 **必须 包含 `access_key`,`timestamp`,`sign`三个参数**，签名生成算法请见下文\n\n|参|意|\n|---|---|\n|access_key|请求凭证|\n|timestamp|10位时间戳(秒)，请求有效期为服务器时间 |\n|sign|请求签名|\n    \n- 下文中所有大写单词，均指代请求时的实际值\n\n - `ACCESS_KEY` 均代表`access_key`的值\n - `SECRET_KEY` 均代表`secret_key`的值\n - `TIMESTAMP`均代表`timestamp`的值\n - `SIGN`均代表`sign`的值\n- 请使用 `https` 协议\n\n# 请求示例\n> 下面将用 [控制台-培训-详情](https://postman.mudu.tv/#dca1962b-9421-40d7-9da1-ac195714b9d3) 接口做简单示例，该接口需要`POST`请求，且只有一个`id`参数\n\n1. 获取请求地址 `https://youke.mudu.tv/console/Index.php?c=live&a=Info`\n2. 在请求`BODY` 中加入`id`参数\n3. 在请求URL中加入参数 `access_key`,`timestamp`,`sign`，新的请求URL为：  `https://youke.mudu.tv/console/index.php?c=live&a=info&timestamp=TIMESTAMP&access_key=ACCESS_KEY&sign=SIGN`\n4. 发送`POST`请求\n5. 返回值为json对象，`code` 为返回状态码，2XX 为成功。`msg` 为返回信息，`data` 为返回数据，无数据返回时，会返回`null`\n\n```json\n{\n    \"code\": 200,\n    \"msg\": \"success\",\n    \"data\": {\n        \"id\": \"0Nmj3O5QyhqyBqPCO8O7O8glEz7CEsmz\",\n        \"account_id\": 6,\n        \"name\": \"测试培训\",\n        \"status\": 1,\n        \"live_status\": 4,\n        \"link_status\": 0,\n        \"link_apply_status\": 0,\n        \"stream\": \"UIJT8T\",\n        \"stream_status\": 0,\n        \"client_id\": 1484962,\n        \"cover\": \"\",\n        \"background\": null,\n        \"created_at\": \"2018-05-10 17:13:38\",\n        \"updated_at\": \"2018-05-11 09:52:52\",\n        \"deleted_at\": null,\n        \"will_start\": \"2018-05-10 17:13:00\",\n        \"will_stop\": \"2018-05-11 09:52:47\",\n        \"last_start\": \"2018-05-11 09:52:20\",\n        \"last_stop\": \"2018-05-11 09:52:52\",\n        \"comment_enable\": 1,\n        \"media_id\": 0,\n        \"watch_amount\": 0,\n        \"white_list_num\": 2514,\n        \"attend_num\": 1,\n        \"manager_id\": null,\n        \"watch_mode\": 1,\n        \"department_id\": null,\n        \"issue_enable\": 0,\n        \"ecdn_enable\": 0,\n        \"type\": 1,\n        \"interactive_room_id\": \"\",\n        \"mrtc_addr\": \"\",\n        \"doc_event_id\": null\n    }\n}\n```\n#请求签名算法\n请求签名算法将以  [控制台-培训-详情](https://postman.mudu.tv/#dca1962b-9421-40d7-9da1-ac195714b9d3) 为示例说明。示例涉及代码，均以PHP实现，仅供参考。\n\n1. 将所有PSOT和`access_key`,`timestamp`,`secret_key`合并到一维数组中,并将所有value转换为string类型  \n\n```php\narray (size=7)\n  'access_key' => string 'ACCESS_KEY' (length=10)\n  'secret_key' => string 'SECRET_KEY' (length=10)\n  'timestamp' => string '1528786704' (length=10)\n  'id' => string '0Nmj3O5QyhqyBqPCO8O7O8glEz7CEsmz' (length=32)\n```\n\n2. 将该数组根据KEY按照字典顺序排序\n\n```php\narray (size=7)\n  'access_key' => string 'ACCESS_KEY' (length=10)\n  'id' => string '0Nmj3O5QyhqyBqPCO8O7O8glEz7CEsmz' (length=32)\n  'secret_key' => string 'SECRET_KEY' (length=10)\n  'timestamp' => string '1528786704' (length=10)\n```\n\n3. 将该数组转换为字符串，注意 **不要** 将中文编码为UNICODE\n\n```json\n{\n\t\"access_key\": \"ACCESS_KEY\",\n\t\"id\": \"0Nmj3O5QyhqyBqPCO8O7O8glEz7CEsmz\",\n\t\"secret_key\": \"SECRET_KEY\",\n\t\"timestamp\": \"1528786704\"\n}\n```\n\n4. sha1 算出签名\n\n``` \n77e0461cf5af753a615aec855c3191f04dc7e415 \n```\n\n# 关于错误码的说明\n目前全局错误码仅有下方所示几种，其余错误请结合错误信息判断。如有疑问，请联系我们。\n\n|code|msg|说明|\n| --- |---|---|\n|490|Frequency limited.|请求频率限制，具体限制请参见频率限制一节|\n|491|Sign error.|签名错误|\n|492|empty param or timestamp error|必传参数错误或传入时间戳和系统时间差距大于300s|\n|500|unknown error|未知错误|\n\n\n# 频率限制\n单帐号 100次/分钟","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"2911003","team":113999,"collectionId":"bbc708ea-1968-41b9-8f63-100eafcf31c2","publishedId":"RWEdtLNs","public":true,"publicUrl":"https://postman.mudu.tv","privateUrl":"https://go.postman.co/documentation/2911003-bbc708ea-1968-41b9-8f63-100eafcf31c2","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2020-08-10T09:39:58.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/7852320b5dd3e564d6432f2b5cf3e7f9768c9640e6c8cc48fa21b9cebd6cfe64","favicon":"https://mudu.tv/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://postman.mudu.tv/view/metadata/RWEdtLNs"}