自定义授权

一、功能路径

我的直播 --> 频道设置-->观看条件设置-->自定义授权

二、功能介绍

打开直播观看页时,直播系统会调用客户系统的验证接口,客户自定义验证逻辑,验证通过后才能打开保利威视直播观看页,并且接口返回的观众账号具有唯一性,即同一个账号不能在两个地方同时登录,较早登录的账号会被踢出。
自定义授权观看

  1. Secretkey:用于校验签名的生成。
  2. 自定义URL:用于自定义授权验证的API接口。

三、自定义授权流程详解

  1. 在自定义URL处填写用户的授权验证API接口,需要完整的不带参数的url地址(不能是localhost等本地服务器地址,且不能带 ? 号),如:http://myWebsite.com/auth。
  2. 直播系统会将id(直播的频道)、ts(当前时间的毫秒级时间戳)、sign(用于校验的签名)、url(回调的url地址)等参数提交给用户自定义的API接口,用户需要对字符串secretkey + id + secretkey + ts进行MD5加密后与sign参数的值做比较判断是否合法。
  3. 通过校验和自定义验证逻辑后,客户系统将userid(学员唯一标识,仅支持英文大小写、数字和下划线)、nickname(昵称)、avatar(头像)、actor(用户头衔名称,非必须)、actorFColor(用户头衔字体颜色,非必须,请使用CSS Hex值带#号)、actorBgColor(用户头衔背景颜色,非必须,请使用CSS Hex值带#号)、ts(当前时间的毫秒级时间戳)、sign(校验签名)等参数提交到回调的url接口。
  4. 直播系统会对签名做校验后判断是否允许学员观看.校验通过后将进入直播观看页,聊天区域将显示观众的昵称和头像。一次成功请求后,该链接将失效。

流程图如下

自定义授权流程图

四、参数说明

自定义授权观看参数说明

五、代码示例(PHP)

<?php
$secretkey = "jlw42byyJ6"; //后台secretKey,在自定义授权地址设置页面
$id        = $_GET["id"]; //直播的频道id
$ts        = $_GET["ts"]; //当前时间
$sign      = $_GET["sign"]; //用于检验的签名
$url       = $_GET["url"]; //回调的url
$md5       = md5($secretkey . $id . $secretkey . $ts); //若md5字符串与sign不符合,则不做任何处理
if (!($sign == $md5)) {
    return;
}
$userid       = "eciyhturt8"; //学员唯一标识
$nickname     = urlencode(base64_encode("保利威")); //学员的昵称
$marqueeName     = urlencode(base64_encode("polyv")); //自定义跑马灯内容
$avatar       = "http://live.polyv.net/assets/images/avatars/9avatar.jpg"; //学员的头像
$callbackTs   = time() * 1000; //当前的系统时间
$callbackSign = md5($secretkey . $id . $secretkey . $callbackTs . $secretkey . $userid); //用于检验的签名
$callbackUrl  = $url . "?userid=" . $userid . "&nickname=" . $nickname . "&marqueeName=" . $marqueeName. "&avatar=" . $avatar . "&ts=" . $callbackTs . "&sign=" . $callbackSign; //新的直播页面url
//打开新的直播页面url
echo "<script language='javascript' type='text/javascript'>location.href='" . $callbackUrl . "'</script>"
?>

六、展示效果

http://live.polyv.cn/watch/104400

七、注意事项

  1. .要保证自定义验证接口返回的userid的唯一性,当多个观众使用同一个userid进入观看页时,较早登录的观众会被后面登录的观众踢出,观看页会提示 "帐号在另外的地方登录,您将被退出观看。"如下图:
    退出观看提示

  2. 学员的昵称进行base64加密后再进行urlencode加密,否则可能会造成观看页昵称显示乱码现象。

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

外部授权

一、功能介绍

当需要观众登录机构的用户系统,验证通过后才能进入直播观看页时,可使用外部授权。验证观众是否可观看由机构实现,验证通过后打开的观看页面由保利威实现。
机构后台针对通过验证的观众,打开直播观看页时URL需带上指定的参数,经过直播系统验证请求合法后,直播系统会调用客户在后台设置的自定义授权验证接口,进行接口授权验证,两次验证通过,才能进入直播观看页,并且接口返回的观众账号具有唯一性,即同一个账号不能在两个地方同时登录,较早登录的账号会被踢出。
外部授权

  1. Secretkey:用于校验签名的生成。
  2. 自定义URL:用于外部授权验证的API接口。
  3. 跳转地址:观众直接访问Polyv观看页,会跳转到该地址;若跳转地址为空,则显示默认提示页。

二、展示效果

http://demo.polyv.net/chenwb/open.php

三、外部授权流程详解

  1. 在自定义URL处填写用户的授权验证API接口,需要完整的不带参数的url地址(不能是localhost等本地服务器地址,且不能带 ? 号),如:http://myWebsite.com/auth。
  2. 在请求保利威视直播观看页时需带上userid(用户ID,仅支持英文大小写、数字和下划线)、ts(当前时间的毫秒级时间戳)和sign(用于校验的签名,生成规则是secretkey + userid + secretkey + ts进行MD5加密),如https://live.polyv.cn/watch/125527?userid=6b3a43&ts=1498547407000&sign=dd9dc9e42ad7c0204398e925a4ee0f46
  3. 直播系统会对字符串secretkey+userid+secretkey+ts进行MD5加密后与用户提交的sign参数的值做比较判断是否合法。一次成功请求后,该链接将失效(sign只能成功使用一次)。如果合法,直播系统将调用用户的api接口,并把userid(用户ID)、ts(当前时间的毫秒级时间戳)和token(用于校验的签名)三个参数传给用户。如果不合法,则给出错误提示。
  4. 用户API接口获取userid、ts和token参数后,进行签名验证。如果验证通过,则将学员相关信息(详参“用户系统返回观众信息json说明”)返回给直播系统。
  5. 直播系统接收用户API接口返回的数据,如果验证成功,则进入到保利威视直播观看页,聊天区将显示学员的昵称和头像。如果验证失败,则给出错误提示。

交互图如下

外部授权交互图

四、参数说明

请求观看页所带参数

用户将以下的参数提交给直播的观看页,(例如:https://live.polyv.cn/watch/125527?userid=test&ts=1565948760108&sign=b0b6eb22b6fa5e5684873052c27a6cef)
直播系统会对sign 进行验证,判断是否合法,一次成功请求后,该链接将失效(sign只能成功使用一次)

参数名称 必填 参数说明
userid 观众id,非中文字符串
ts 13位毫秒级时间戳
sign 用户校验的签名,加密规则:secretkey + userid + secretkey + ts

观看页请求观众信息接口参数

观看页请求用户在后台设置的自定义URL获取观众信息,以下为请求所带的参数

参数名 必填 参数说明
userid 观众id,非中文字字符串(请求观看页时所带的userid)
channelId 频道号
ts 当前时间的13位毫秒级时间戳
token 用于校验的签名,生成的规则:对字符串secretkey + userid + secretkey + ts进行MD5加密生成的字符串

用户系统返回观众信息json说明

用户的接口接收到请求后,进行相关检验判断通过后,将学员信息以json格式的信息返回

字段 类型 必填 字段说明
status int 请求结果,1表示成功,0表示失败
userid string 观众ID
nickname string 观众昵称
marqueeName string 自定义跑马灯字段
avatar string 观众头像地址,头像尺寸200*200,体积不超过30KB。
actor string 观众头衔地址
actorFColor string 观众头衔字体颜色,非必须,请使用CSS Hex值并且带# 号
actorBgColor string 观众头衔背景颜色,非必须,请使用CSS Hex值带# 号
param4 string 统计观众观看日志的自定义参数
param5 string 统计观众观看日志的自定义参数
errorUrl string 请求失败时观看页跳转的地址

成功返回:

{"status":1,"userid":"2qwerty","nickname":"testNick","actor":"paul","actorFColor":"#123123","actorBgColor":"#FFFFFF","param4":"param4test","avatar":"http:\/\/live.polyv.net\/assets\/images\/avatars\/9avatar.jpg"}

失败返回:

{"status":0,"errorUrl":"http://test.com"}

注意事项:在使用普通直播观看页时,同时传入了nickname和marqueeName,在观看日志中,marqueeName将作为用户昵称的统计字段

五、代码示例(PHP)

<?php
header("Content-type:application/json;charset=UTF-8"); //媒体格式类型为JSON数据格式
$secretkey = "aDrOt0Cpy8";
$userid    = isset($_GET["userid"]) ? $_GET["userid"] : "";
$ts        = isset($_GET["ts"]) ? $_GET["ts"] : "";
$channelId = isset($_GET["channelId"]) ? $_GET["channelId"] : "";
$token     = isset($_GET["token"]) ? $_GET["token"] : "";
$sign      = md5($secretkey . $userid . $secretkey . $ts);

//用户进行授权验证,返回对应的数据(json格式)
if ($sign == $token) {
    //验证正确
    $array1 = array(
        "status"   => 1, //返回状态
        "userid"   => $userid, //学员唯一标识
        "nickname" => "保利威", //学员昵称
        "marqueeName" => "polyv", //自定义跑马灯字段
        "avatar"   => "http://live.polyv.net/assets/images/avatars/9avatar.jpg", //学员头像
        "actor"   => "VIP",  // 学员头衔,可以不传递
        "actorFColor"   => "#5C96E5",  // 学员头衔字体颜色,可以不传递
        "actorBgColor"   => "#FFFFFF"   // 学员头衔背景颜色,可以不传递
    );
    $json1 = json_encode($array1);
    echo $json1;
} else {
    //验证错误
    $array0 = array(
        "status"   => 0,
        "errorUrl" => "http://xxx.xx.xxxx/error.html", //验证错误跳转的自定义页面
    );
    $json0 = json_encode($array0);
    echo $json0;
}

六、注意事项

  1. .要保证自定义验证接口返回的userid的唯一性,当多个观众使用同一个userid进入观看页时,较早登录的观众会被后面登录的观众踢出,观看页会提示 "帐号在另外的地方登录,您将被退出观看。"如下图:
    被踢

  2. 自定义验证接口需要填写完整的URL地址,且不能是localhost等本地服务器地址。

  3. 自定义验证接口返回给直播系统的数据格式是json格式。

七、错误提示

  1. user not found:请求自定义验证接口错误,或者接口返回的格式不对。
  2. invalid sign:签名错误,sign的生成规则是secretkey+userid+secretkey+ts进行MD5加密。
  3. sign expired:签名过期,每一个sign只能使用一次,使用后需重新生成。
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

页面嵌入

一、功能路径

我的直播 --> 频道设置-->直播间-->页面嵌入

二、功能介绍

您可以通过嵌入Polyv直播播放器代码的方式,在自己网站页面播放直播。
页面嵌入
- 嵌入代码可用于PC端和移动端页面。
- 您还可以通过播放器提供的接口进行播放器控制栏和弹幕的更多控制,详情请参考页面提供的文档链接。

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

播放限制

一.功能途径

我的直播-->频道设置--> 播放器管理-->播放限制

频道设置播放限制

二.功能介绍

播放限制2
1.授权认证

学员登录客户网站后,访问客户网站的播放页面(页面上有POLYV播放器),播放器会请求客户写的授权播放接口(该接口判断学员身份信息后,返回是否允许播放器去播放视频的指令给播放器)。

2.播放网络限制

  • 播放网络白名单:在白名单内的域名可进入直播
  • 播放网络黑名单:在黑名单内的域名不可进入直播

三.使用步骤

1.授权认证
设置-->输入URL-->保存

播放限制3

2.播放网络限制
设置-->输入白名单域名/黑名单域名-->保存
播放限制4

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

功能开关

一.功能途径

我的直播-->频道设置--> 功能开关

功能开关1功能开关2

二.功能介绍

功能开关分为两模块:页面观看页功能、直播聊天室功能
功能开关提供一个简便的方式对部分功能集中起来处理

三.使用步骤

直接点击功能的“开”或者“关”按钮即可

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

广告

一.功能途径

我的直播-->频道设置--> 营销设置-->广告

频道设置广告

二.功能介绍

  • 广告设置分为:页面广告、片头广告、暂停广告三种类型
  • 页面广告:
    • 可选文字广告和图片广告
    • 广告位上限为5个
  • 片头广告:
    • 可选视频广告、图片广告两种
    • 视频广告语图片广告二选一
  • 暂停广告:
    • 为图片广告
      广告设置2

三.使用步骤

  • 页面广告:
    选择广告类型-->上传图片/广告文案-->设置跳转链接
    广告设置4
  • 片头广告:
    选择广告类型-->设置时长-->设置跳转链接-->上传视频链接/上传图片

    视频广告
    广告设置5

    图片广告
    广告设置6

  • 暂停广告:
    设置跳转链接-->上传图片

广告设置8

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

播放器设置

一.功能途径

我的直播-->频道设置--> 播放器管理--> 播放器设置

频道设置播放器设置1

二.功能介绍

  • 播放器功能分为logo设置以及回放播放器设置
  • logo设置主要设置logo的位置、透明度、以及链接地址
  • 回放播放器设置跳转到云点播的后台进行设置

三.使用步骤

播放器设置2

  1. 上传LOGO
  2. 设置LOGO位置
  3. 设置透明度
  4. 输入跳转链接
  5. 默认播放器选择以及观众切换播放器开关
  6. 降低延迟开关:关闭可提高直播流畅,打开可降低延迟
  7. 回放播放器设置(选填)
  8. PC观看页预览图
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

验证码观看

一.功能途径

云直播-->我的直播-->频道设置--> 观看条件设置->验证码观看

观看条件设置1验证码观看

二.功能介绍

  • 验证码观看即输入正确的验证码即可观看直播,该验证码是唯一确定的。
  • 验证码获取:扫客户的公众号进行获取
  • 观看页中可直接输入正确的验证码进行或从客户公众号中获取验证码
  • 该观看条件可给公众号进行吸粉

三.使用步骤

验证码观看-->输入验证码-->上传公众号二维码(非必须操作)-->写弹窗的提示文案(非必须操作)-->保存

验证码观看4

PC端效果预览

验证码观看5验证码观看6

注意:验证码观看,二维码可上传也可不上传。
当上传二维码时,学员需扫二维码进入公众号,从公众号中获取;
当没有上传二维码时,学员输入客户提供的正确二维码即可观看直播

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

登记观看

一.功能途径

云直播-->我的直播-->频道设置-->观看条件设置-->登记观看

观看条件设置1登记观看

二.功能介绍

用户登记相关信息即可观看直播
最多可设置5条信息

三.使用步骤

登记观看-->添加信息-->填写信息标题与信息描述-->保存
登记观看2

在查看登记列表处可以查看登记的内容
登记观看3

注意:当选择信息类型为下拉选择的时候,选项详情最多为8个

登记观看4

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

白名单观看

一.功能途径

云直播-->我的直播-->频道设置-->观看条件设置-->白名单观看
观看条件设置1白名单设置

二.功能介绍

  • 处于白名单里的用户输入正确的验证后,可直接观看,可理解为设置VIP用户

三.使用步骤

白名单观看-->下载白名单模板(excel表格)-->输入白名单信息-->导入白名单-->保存

白名单观看3

可在查看白名单处查看白名单信息

白名单观看5

注意:导入白名单的白名单模板必须为制定的模板

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...