帮助与支持

1、说明

本文档接口均为http接口,遵循http协议。

2、接口地址

若未做特殊说明,本文档接口地址的域名均为api.open.lecloud.com,地址均为http://api.open.lecloud.com/live/execute。

3、请求数据格式

若未做特殊说明,请求本文档接口时均以查询字符串形式传递参数。GET之外的请求方法,查询字符串即可以拼接在URI中,也可以放在请求正文中,放在请求正文中时需要添加请求头:

Content-Type: application/x-www-form-urlencoded;charset=utf-8

目前本文档接口只提供json格式的响应。

目前本文档接口均使用UTF-8编码,因此若添加请求头Accept-Charset,请务必包含utf-8,或者不添加此请求头。

4、公共参数

若未做特殊说明,本文档所有接口均需传以下五个参数:

参数名类型说明
methodstring要调用的OpenAPI接口方法名称,如:letv.rtmp.stream.search
verstring版本号,用于区分相同接口不同版本功能,如:3.0
useridint客户唯一标识码,客户在乐视云计算公司门户注册后自动生成
timestamp

long

时间戳,由1970年1月1日开始所经过的毫秒数表示,早于服务器时间10分钟内的请求有效
signstring验证码,生成规则见下面的《权限验证》

以上参数在后文中不再做说明

5、响应数据格式

Casehttp状态码数据格式
正常200Json
数据没有发生变化,客户端缓存有效304
客户端错误的使用了接口或者违反了一些业务规则约束。
注意:对于用户输入错误异常,同一个IP一分钟内输入错误20次,IP将被禁用10分钟。
400{
errCode:””, // 错误编码
errMsg:”” // 错误消息
}
服务器未知异常500{
errMsg:”” // 错误消息
}

注意:如果一个字段为null或者空串,Json中不包含该字段。

6、权限验证

参数sign用于验证请求是否具有合法权限,其生成规则如下:

    一、把除sign外的所有参数(包括另外的公共参数)按key升序排序。

    二、把key和它对应的value拼接成一个字符串。按步骤1中顺序,把所有键值对字符串拼接成一个字符串。对于url类的参数,请使用url编码前的字符串。

    三、把分配给的secretkey(此处假设为:ABCDEFGHIJK)拼接在第2步骤得到的字符串后面。    

    四、计算第3步骤字符串的md5值,使用md5值的16进制字符串作为sign的值。

sign生成举例:

模拟数据,如下:

用户密钥:

secretkey=900150983cd24fb0d6963f7d28e17f72

公共参数

method=lecloud.cloudlive.activity.create

ver=4.0

userid=300100

timestamp=1470412800000

系统参数:

activityName=testName

activityCategory=001

startTimeTS=1470585600000

endTimeTS=1470758400000

playMode=0

liveNum=2

codeRateTypes=16,19

 

步骤一:按key升序,如下

activityCategory=001

activityName=testName

codeRateTypes=16,19

endTimeTS=1470758400000

liveNum=2

method=lecloud.cloudlive.activity.create

playMode=0

startTimeTS=1470585600000

timestamp=1470412800000

userid=300100

ver=4.0

 

步骤二:按照步骤一的顺序,拼接所有keyvalue,如下

activityCategory001activityNametestNamecodeRateTypes16,19endTimeTS1470758400000liveNum2methodlecloud.cloudlive.activity.createplayMode0startTimeTS1470585600000timestamp1470412800000userid300100ver4.0

 

步骤三:将用户密钥(secretkey)的值,拼接到步骤二后边,如下

activityCategory001activityNametestNamecodeRateTypes16,19endTimeTS1470758400000liveNum2methodlecloud.cloudlive.activity.createplayMode0startTimeTS1470585600000timestamp1470412800000userid300100ver4.0900150983cd24fb0d6963f7d28e17f72

 

步骤四:计算步骤三中字符串的md5值,即为sign,如下

md5(activityCategory001activityNametestNamecodeRateTypes16,19endTimeTS1470758400000liveNum2methodlecloud.cloudlive.activity.createplayMode0startTimeTS1470585600000timestamp1470412800000userid300100ver4.0900150983cd24fb0d6963f7d28e17f72)

sign = 6e39cb472adc03a4a1e479b9bb457e75