用户工具

站点工具


open:api

Vhall Open API

请在平台注册,并创建应用。取得App_Key和Secret_Key。然后可以通过如下接口创建直播流。
创建后可以在网页后台看到该直播。
使用token和stream_name通过sdk发起直播。

直播相关API

创建直播

参数 含义
token 一个自定义的字符串,主要用于发起直播时与直播ID一起用于验证权限。
app_key 创建应用后取得的app_key
signed_at unix时间戳
sign 权限验证签名,具体见本页 签名方式
{
    "code": 200,
    "msg": "success",
    "data": {
        "token": "testtoken",
        "app_id": "1",
        "stream_name": "db414bb0fc2b38d32f2aecdd94190fa5",
        "updated_at": "2015-04-27 03:31:26",
        "created_at": "2015-04-27 03:31:26",
        "id": 1
    }
}

更新直播

主要用于自主更新直播的token

参数 含义
id 要更新的直播id
token 新的token值
app_key 创建应用后取得的app_key
signed_at unix时间戳
sign 权限验证签名,具体见本页 签名方式

取得直播信息

取得指定id的直播信息

参数 含义
id 要取得的直播id
app_key 创建应用后取得的app_key
signed_at unix时间戳
sign 权限验证签名,具体见本页 签名方式

取得指定token的直播列表

参数 含义
token 取得所有token与此相同的直播信息
app_key 创建应用后取得的app_key
signed_at unix时间戳
sign 权限验证签名,具体见本页 签名方式

取得本应用下的直播列表

参数 含义
app_key 取得所有此app下的直播信息
signed_at unix时间戳
sign 权限验证签名,具体见本页 签名方式

删除直播

参数 含义
id 要删除的直播id
app_key 创建应用后取得的app_key
signed_at unix时间戳
sign 权限验证签名,具体见本页 签名方式

签名方式

将接口中要求传递的所有参数(不包含sign,包含时间戳signed_at):

  1. 按参数名升序排列,
  2. 然后按参数名1+参数值+参数名2+参数值拼接
  3. 在首尾各加上secret_key
  4. 计算md5作为sign

以创建直播为例:

secret_key="ssssssssssssssss";
params={
"app_key":"xxxxxxxxxxxxx",
"signed_at":"timestamp_now",
"token":"the_token",
};
sign=md5("ssssssssssssssssapp_keyxxxxxxxxxxxxxsigned_attimestamp_nowtokenthe_tokenssssssssssssssss");
// 得出 sign=="6da8cd953e435a6e3774e48d0a37a319";

接口返回值说明

以json对象返回,主体结构包括code,msg,data三个属性。code和msg表示成功失败等状态,按照http状态码的约定,200为成功,400,500等为失败。data部分为返回数据。

open/api.txt · 最后更改: 2016/01/18 13:26 由 yong.xu