用户工具

站点工具


vhall_open:sdk引入_初始化并注入权限验证

SDK引入、初始化并注入权限验证

1.依赖库

本SDK依赖于JQuery库,请在需要引入JQuery的页面按以下代码示例进行引入,对JQuery版本没有要求

<script src=“http://cnstatic01.e.vhall.com/3rdlibs/jquery/1.11.2/jquery.min.js” type=“text/javascript”></script>

2.引入JS文件

在需要调用SDK的页面插入以下代码以引入JS文件:

<script type=“text/javascript” src=“http://cnstatic01.e.vhall.com/jssdk/dist/2.3.3/vhallSDK.js”></script>

支持https

注:支持使用AMD/CMD标准模块加载规范加载

3.初始化及权限验证

请使用以下的方法和参数进行SDK的初始化以及权限的验证

VHALL_SDK.init({
   account : '',//必填,唯一用户id,与使用第三方创建用户接口所传的third_user_id需一致)
   email : '',//参数必填,值可为空,用于与嵌入视频区用户同步
   username : '',//必填,用户昵称用以在各模块中显示
   roomid :'',//必填,当前聊天所在活动id
   app_key :'',//必填,启用服务唯一验证,API/SDK权限申请后生成,此参数名在1.0.0版本中为appkey,使用当前版本时请更新
   signedat :'',//必填,启用服务唯一验证,unix时间戳
   sign :'',//必填,启用服务唯一验证,有效期一小时,见下面的生成规则
   facedom :'',//可选,当使用微吼表情时必填,呼出表情弹窗dom属性 如('#id','.class'等)
   textdom : '',//可选,当使用微吼表情时必填,插入表情文本dom属性 如('#id','.class'等)
   videoContent : '',//【新】可选,当需要使用视频模块时,插入视频dom属性 如('#id','.class'等)
   docContent: '',//【新】可选,当需要使用文档模块时,插入视频dom属性 如('#id','.class'等)
});

注:如使用了网页嵌入,为确保嵌入页面的用户与SDK各模块中的用户是同一个用户,请尽量传入与视频区嵌入相同的email参数,否则会被统计成两个不同的用户

以上参数sign由PHP生成,其生成规则如下:

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

示例如下

<?php
$secret_key = "f145b675f441cc00dd3e55746a0f4780";
$params = [
    "roomid"=> "123456789",
    "account"=> "12345",
    "email"=> "zhangsan@vhall.com",
    "username"=> "zhangsan",
    "app_key"=> "3eb72619af748d73f7fda1e6b0c692a9",
    "signedat"=> "1484620708"
];
// 按参数名升序排列
ksort($params);
// 将键值组合
array_walk($params,function(&$value,$key){
	$value = $key . $value;
});
// 拼接,在首尾各加上$secret_key,计算MD5值
$sign = md5($secret_key . implode('',$params) . $secret_key);
// 结果形如
// $sign=md5("f145b675f441cc00dd3e55746a0f4780account12345app_key3eb72619af748d73f7fda1e6b0c692a9emailzhangsan@vhall.comroomid123456789signedat1484620708usernamezhangsanf145b675f441cc00dd3e55746a0f4780");
// 计算结果
// $sign = '92eec52c58b9bddc0ba663c75a3c1f7f'; //签名有效期只有一个小时 

VHALL_SDK初始化时服务端返回的错误码

错误码 说明
1001活动不存在
1002用户昵称不能空
1003用户id不能空
1004appkey不存在
1005签名验证超时
1006签名错误
1007当前活动不是该appkey下所属活动

对上述内容中所提appkey、app_key以及secret_key三个参数的说明:

appkey和app_key均表示添加应用后所得到的AppKey列对应的值

secret_key表示添加应用后所得到的SecretKey(注意与AppSecretKey区分)列对应的值

vhall_open/sdk引入_初始化并注入权限验证.txt · 最后更改: 2017/09/29 15:38 由 yan.gao