Merge remote-tracking branch 'origin/master'

翁力
2 parents 0cd1ef69 dd0c376c
Showing 3 changed files with 193 additions and 8 deletions
0. 公共组件/1.1 SHA1签名.md
1. 点播云/内容输出接口.md
8.直播云/1.2 获取直播URL接口.md
@@ -2,18 +2,31 @@
 Title: SHA1签名
 */
+
+### 系统参数说明 ###
+
+|名称	|类型	|必选	|描述|
+| :----------- | :------: | :------: | :------: |  
+|sp_id	|string	|Y	|入驻服务开发者(SP)的应用唯一标识码，由开放平台统一分配并提供(一个SP可自行创建多个应用号)|
+|timestamp	|int	|Y	|当前Unix时间戳，请保证请求服务器时间正确，有些API接口是有时效性要求的|
+|ver	|string	    |Y	|协议版本号，统一取值为1.0|
+|sign	|string	|Y	|验证码，生成规则详见下面的说明，其中sp_key是由开放平台统一分配并提供的SP私钥|
+
+
 ### 签名描述 ###
 签名机制
 SHA1 加密
-1. 对所有传入参数按照字段名的 ASCII 码从小到大排序（字典序）后，使用 URL 键值 对的格式（即 key1=value1&key2=value2…）拼接成字符串 string1，
-   注意：值为空的参数不 参与签名；
+1. 对所有传入参数(含系统参数和接口参数)按照字段名的 ASCII 码从小到大排序（字典序）后，使用 URL 键值 对的格式。
+  （即 key1=value1&key2=value2…）拼接成字符串 string1， 
+ 注意：值为空的参数不参与签名，所有请求参数值都需要进行URL编码。
 2. 在 string1 最 后 拼 接 上 key=sp_key得 到 stringSignTemp 字 符 串 ， 并 对 stringSignTemp 进行 sha1 运算，再将得到的字符串所有字符转换为大写，
    得到 sign 值 signValue。
 3. 对传入参数中所有键值对的 value 进行 urlencode 转码后重新拼接成字符串 string2。
 4. 将 sign=signValue拼接到string2后面得到最终的 参数 字符串。
+
 #### Java代码示例
 ```java 
@@ -23,7 +36,7 @@ SHA1 加密
 		String sp_key = "xxxxxxxxxxx";		//开发者帐号对应的key.  请开发者谨慎保管此值。
 		Map<String, String> map = new HashMap<String,String>();
-		map.put("sp_id","iqhpk8pl19");  //开发者帐号对应的10位ID ，所有接口参数都必须有此参数。
+		map.put("sp_id","xxxxxxxxxx");  //开发者帐号对应的10位ID ，所有接口参数都必须有此参数。
 		map.put("param1_keyname", "Parm1_vaule");   //接口需要的参数1 
 		map.put("param2_keyname", "Parm2_vaule");   //接口需要的参数2 。。。  等等
@@ -36,7 +49,7 @@ SHA1 加密
 		String sp_key = "xxxxxxxxxxx";		//开发者帐号对应的key.  请开发者谨慎保管此值。
 		Map<String, String> map = new HashMap<String,String>();
-		map.put("sp_id","iqhpk8pl19");  //开发者帐号对应的10位ID ，所有接口参数都必须有此参数。
+		map.put("sp_id","xxxxxxxxxx");  //开发者帐号对应的10位ID ，所有接口参数都必须有此参数。
 		map.put("param1_keyname", "Parm1_vaule");   //接口需要的参数1 
 		map.put("param2_keyname", "Parm2_vaule");   //接口需要的参数2 。。。  等等
-/*
- *  
- */
 \ No newline at end of file
+/*
+Title: 1.1 获取点播信息接口
+*/
+
+### 接口描述 ###
+
+
+### 接口地址 ###
+http://api.cnlive.com/open/api/dianbo/getVodInfo
+
+### 接口协议 ###
+HTTP GET
+
+### 接口请求参数 ###
+- vId：节目唯一标识
+- sp_id：应用ID
+- timestamp：时间戳，精确到秒
+
+### 返回值  ###
+返回JSON格式的节目元数据信息，json示例如下：
+
+``` json
+{
+    "message":"请求成功",
+    "data":{
+        "MAM_VideoUrl":"http://wideo03.cnlive.com/video/data1/2016/0725/137519/800/419c46d67fb34b46adbd8b7de450a0f2_137519_800.m3u8",
+        "MAM_VideoEditor":"许真真",
+        "weight":"80",
+        "MAM_VideoUHUrl":"",
+        "pageUrl":"http://www.cnlive.com/fengcaidasai/v_gy2tmmrxgy.html",
+        "MAM_VideoLUrl":"http://wideo03.cnlive.com/video/data1/2016/0725/137519/400/419c46d67fb34b46adbd8b7de450a0f2_137519_400.m3u8",
+        "vipFlag":"0",
+        "CMSChannelName":"华语风采大赛",
+        "type":"program",
+        "packagePomID":"3_fengcaidasai/dianfengduijue/",
+        "MAM_BigPostUrl":"http://y3.cnliveimg.com:8080/image/itv/2016/0725/419c46d67fb34b46adbd8b7de450a0f2_137519_101.jpg",
+        "cmsChannelID":"fengcaidasai/",
+        "MAM_ProducerID":"先锋派",
+        "activityId":"",
+        "title":"刘子赫孙悟空大闹天宫",
+        "docSubTitle":"刘子赫孙悟空大闹天宫",
+        "MAM_NodeID":"016-020-003",
+        "MAM_TVColumMarkID":"",
+        "playAuto":"xiangguanshipin",
+        "docID":"656276",
+        "onePomID":"3_419c46d67fb34b46adbd8b7de450a0f2",
+        "MAM_SmallPosterUrl":"http://y3.cnliveimg.com:8080/image/itv/2016/0725/419c46d67fb34b46adbd8b7de450a0f2_137519_100.jpg",
+        "CMCCNodeID":"",
+        "MAM_PrgType":"1",
+        "publishDate":"2016-07-25 16:47:32",
+        "mediaId":"419c46d67fb34b46adbd8b7de450a0f2",
+        "MAM_Duration":"293000",
+        "MAM_CPNAME":"魅力快线3",
+        "MAM_NodeName":"大型专题/华语风采大赛/巅峰对决",
+        "vip_product_id":"",
+        "status":"1",
+        "WEB_Copyright":1,
+        "MAM_PosterUrl":"http://y3.cnliveimg.com:8080/image/itv/2016/0725/419c46d67fb34b46adbd8b7de450a0f2_137519_100.jpg",
+        "cmsColumnID":"fengcaidasai/dianfengduijue/",
+        "MAM_CreatDate":"2016-07-25 16:22:45",
+        "APP_Copyright":1,
+        "docBodyContent":"",
+        "MAM_VideoFlashUHUrl":"",
+        "MAM_VideoFlashHUrl":"http://wideo03.cnlive.com/video/data1/2016/0725/137519/1500/419c46d67fb34b46adbd8b7de450a0f2_137519_1500.mp4",
+        "MAM_VideoHUrl":"http://wideo03.cnlive.com/video/data1/2016/0725/137519/1500/419c46d67fb34b46adbd8b7de450a0f2_137519_1500.m3u8",
+        "CMSColumnName":"巅峰对决",
+        "CMCCID":"",
+        "freePlayLength":"60",
+        "MAM_VideoFlashUrl":"http://wideo03.cnlive.com/video/data1/2016/0725/137519/800/419c46d67fb34b46adbd8b7de450a0f2_137519_800.mp4",
+        "docDescription":"刘子赫精彩演绎孙悟空大闹天宫。",
+        "MAM_TVDate":"",
+        "modules":[
+            {
+                "id":"xiangguanshipin",
+                "title":"相关推荐"
+            }
+        ],
+        "colName":"",
+        "MAM_VideoFlashLUrl":"http://wideo03.cnlive.com/video/data1/2016/0725/137519/400/419c46d67fb34b46adbd8b7de450a0f2_137519_400.mp4"
+    },
+    "errorCode":"0"
+}
+```
+
+JSON属性说明： 四路播放地址至少一个有效
+
+<table style="font-size:14px" >
+ <tr>
+      <td>字段名称</td>
+      <td>描述</td>
+      <td>备注</td>
+   </tr>
+   <tr>
+      <td>errorCode</td>
+      <td>返回码</td>
+      <td>0：成功</td>
+   </tr>
+   <tr>
+      <td>message</td>
+      <td>返回信息</td>
+      <td></td>
+   </tr>
+   <tr>
+      <td>MAM_VideoUrl</td>
+      <td>播放地址</td>
+      <td></td>
+   </tr>
+   <tr>
+      <td>MAM_PosterUrl</td>
+      <td>图片地址</td>
+      <td></td>
+   </tr>
+   <tr>
+      <td>status</td>
+      <td>状态</td>
+      <td>1：已发布；2：下线</td>
+   </tr>
+   <tr>
+      <td>cmsColumnID</td>
+      <td>栏目ID</td>
+      <td></td>
+   </tr>
+   <tr>
+      <td>freePlayLength</td>
+      <td>免费播放时长</td>
+      <td></td>
+   </tr>
+</table>
+
+
+参数需进行加密，示例：
+
+详细签名 http://bj.gitlab.cnlive.com/boss-team/OPEN_API/blob/master/0.%20%E5%85%AC%E5%85%B1%E7%BB%84%E4%BB%B6/1.1%20SHA1%E7%AD%BE%E5%90%8D.md
+
+``` java
+public String getPlayVideo(ModelMap model,HttpServletRequest request) {
+			String result = "";
+			Map params = new HashMap<>();
+			params.put("sp_id", "iqhpk8pl19");
+			params.put("vId", "419c46d67fb34b46adbd8b7de450a0f2");
+			params.put("timestamp", System.currentTimeMillis()/1000+"");
+			String url = OpenUtil.buildURL("http://api.cnlive.com/open/api/dianbo/getVodInfo", params, "672db30805f848f59ec3728f8347a4a0");
+			HttpURLConnection connection;
+			try {
+				URL requestUrl = new URL(url);
+				connection = (HttpURLConnection)requestUrl.openConnection();
+				connection.setRequestMethod("GET");
+				connection.setDoInput(true);
+				connection.setDoOutput(true);
+				connection.connect();//连接
+				
+				//获得返回值
+				if(connection.getResponseCode() == HttpURLConnection.HTTP_OK){
+					InputStream in = connection.getInputStream();
+					String currentLine = "";
+					if(in != null){
+						BufferedReader br = new BufferedReader(new InputStreamReader(in,"utf-8"));
+						while((currentLine = br.readLine()) != null){
+							result += currentLine;
+						}
+						br.close();
+					}
+				}
+			}catch (Exception e) {
+				e.printStackTrace();
+			}
+			
+			if(BaseUtil.notBlank(result)) {
+				JSONObject resultJson = JSONObject.parseObject(result);
+				model.put("videoInfo", resultJson);
+			}
+			
+			return "play_demo";
+		}
+```
 \ No newline at end of file
@@ -15,7 +15,7 @@
 | cid| string | true   | 直播频道ID |
 | uid| string | false   | 用户标识（uuid_时间戳)，不传为0 |
 | sid| string | false   | 用户ID，不传为0 |  
-| type | string | false | hls(H5/APP使用）,mp4(Flash使用），不传则默认为hls
+| type | int | false | 0(HLS流），1(RTMP/MP4流），不传则默认为0
 | retry | int | false | 重试次数，从0开始，不断累加，不传为0 |
 | rate | int |  false | 1-流畅，2-标清，3-高清，4-超清，不传为0 |
 | sign | String | false | APP必须使用，H5不用，签名规则见<a href="http://help.open.cnlive.com/common.html">签名详情</a>  |
 \ No newline at end of file