3.2 接口文档
获取凭证的签名
1. 第三方接口开发说明
1.1.1 基础版接口说明
1.1.2 开发版接口说明
1.2基础版接口
1.2.1 获取开放的应用列表
1.2.2 进入应用
1.2.3 获取进入应用URL
1.2.4 获取请求附加参数
1.2.5 获取区域信息
1.2.6 生成roomCode-authCode
1.2.7 获取运行数
1.3开发版接口-应用管理
1.3.1 查询应用一览
1.3.2 上传应用程序包接口
1.3.3 上传课程封面图接口
1.3.4 创建应用
1.3.5 修改应用
1.3.6 更新应用上-下架状态
1.3.7 删除应用
1.3.8 后台启动VR应用
1.3.9 后台关闭VR应用
1.3.10 批量停止正在运行的应用
1.3.11 获取运行应用一览
1.3.12 获取已结束进程一览
1.4开发版接口-预启动应用
1.4.1 查询预启动应用一览
1.4.2 创建预启动应用接口
1.4.3 更新预启动应用接口
1.4.4 删除预启动应用接口
1.5开发版接口-Task管理
1.5.1 获取指定Task信息
1.5.2 获取使用次数最高的10个应用
1.5.3获取使用时长最高的10个应用
1.5.4按省统计应用使用情况
1.5.5按某个省统计各市使用情况
1.5.6统计其他使用情况
1.5.7统计总使用次数
1.5.8统计总使用时长
1.5.9统计当日使用次数
1.5.10统计当日使用时长
1.6开发版接口-节点管理
1.6.1渲染节点查询(分页
1.7开发版接口--VR管理
1.7.1客户端查询(分页)
1.7.2获取VR客户端资源使用情况
1.7.3VR客户端监控页面
1.8开发版接口-分组管理
1.8.1 分组查询
1.8.2添加组别
1.8.3修改组别
1.8.4删除组别
1.8.5设置组别的运行模式
1.8.6 获取组别的运行模式
1.8.7渲染服务器绑定组别
1.8.8组别批量绑定服务器
1.8.9渲染服务器解绑定组别
1.8.10组别批量解绑定服务器
1.8.11通过服务器ID和组别ID解绑定渲染服务器组别
1.9开发版接口-接入管理
1.9.1接入管理一览(分页)
1.9.2添加接入凭证
1.9.3更新接入管理
1.9.4删除接入管理
1.9.5更新接入后台密钥
1.9.6创建客户端凭证密钥
1.9.7清除客户端凭证密钥
1.10开发版接口-其他
1.10.1获取系统名称
1.10.2获取系统版本号
1.10.3获取眼镜客户端资源监控数据
1.10.4获取服务端资源监控数据
1.10.5 远程桌面连接
1.11开发版接口-参数设置
1.11.1参数设置查询
1.11.2无操作时限-查询
1.11.3无操作超时-更新
1.11.4存储-查询
1.11.5应用存储类型存储-更新
1.11.6是否保存VR监控数据-更新
1.11.7VR监控数据保存期限-更新
1.11.8VR是否保存服务器资源使用率数据-更新
1.11.9是否开启应用一览页面-查询
1.11.10是否开启应用一览页面-保存
1.11.11 IP黑白名单-查询
1.11.12 IP黑白名单-新增
1.11.13 IP黑白名单-删除
1.11.14 端口映射-查询
1.11.15 端口映射-新增
1.11.16 端口映射-更新
1.11.17 端口映射-删除
1.11.18 定制免费版Logo-查询
1.11.19 定制免费版Logo-更新
1.11.20 免费版Logo-清除
1.11.21免费版Logo圆盘-保存
2.code对照
code对照
3.后台功能
3.1接入管理
-
+
首页
1.2.2 进入应用
**1.2.2 进入应用** **注意:该接口是进入应用的直接跳转接口,配合a标签使用,没有消息码的返回.** | 请求方式 |GET | | ------------ | ------------ | | **请求URL** | http:// {LarkXR3.2管理服务器IP}:8181/webclient/ | **升级说明** - 接口地址由 “/enterAppli”变更为“/appli/start”。 - 3.2.10版本开始,接口地址由 “/appli/start”变更为“/webclient”。 - 3.2.21版本开始,参数"roomCode"字段,变更为"authCode" **参考样例1** ``` <a href="http://192.168.0.55:8181/webclient?appliId=879408743551336448&codeRate=8000&frameRate=30" target="_blank"> <button>进入应用</button> </a> ``` **参考样例2**(附加参数,注意:需要编辑应用,“是否传递TaskId”选择“是”) ``` <a href="http://192.168.0.55:8181/webclient?appliId=879408743551336448&codeRate=8000&frameRate=30&extraParam.userName=zhangsan&extraParam.age=12" target="_blank"> <button>进入应用</button> </a> ``` **参考样例3**(带有客户端凭证) ``` 例如: <a href="http://192.168.0.55:8181/webclient?appliId=879408743551336448&codeRate=8000&frameRate=30&appKey=Jx5MQoo1×tamp=1585729005673&signature=4C1BFE264A113A99C526BF5565EEBE642792A0B6" target="_blank"> <button>进入应用</button> </a> ``` **参考样例4**(演示/互动模式) ``` 演示/互动模式:口令模式 生成authCode(PS: 3.2.21以前版本,口令字段为roomCode)方法:参照免费接口1.2.6 演示者:http://192.168.0.55:8181/webclient?appliId=879408743551336448&codeRate=8000&frameRate=30&playerMode=1&userType=1&authCode=888888 观看者(参与者):http://192.168.0.55:8181/appli/start?appliId=879408743551336448&codeRate=8000&frameRate=30&playerMode=1&userType=0&authCode=888888 演示/互动模式:taskId模式 演示者:http://192.168.0.55:8181/webclient?appliId=879408743551336448&codeRate=8000&frameRate=30&playerMode=1&userType=1 观看者(参与者):http://192.168.0.55:8181/webclient?appliId=879408743551336448&codeRate=8000&frameRate=30&playerMode=1&userType=0&taskId=733006441014624256 演示/互动模式使用客户端访问密钥 演示者:需要在密钥有效期内进入应用; Url后面加参数:&appKey=77Ekeapp& timestamp=1594804883818&signature=EA4A9425AE1BBB52FEEC27B4A478E268466D3E 观看者(参与者):无需在密钥有效期内,只要演示者没有退出应用,就可以随时进入应用; 连接后面加参数:&appKey=77Ekeapp& timestamp=1594804883818&signature=EA4A9425AE1BBB52FEEC27B4A478E268466D3E ``` | 名称 | 类型 | 是否必须 | 描述 | | ------------ | ------------ | ------------ | ------------ | | appliId | Long | 必须 | 应用ID | | codeRate | Int | 可选 | 码率,如:3000,5000,8000 ,10000,20000,30000,50000,100000 | | frameRate | Int | 可选 | 帧率,如30,60 | | extraParam.XXX | String | 可选 | 传递给云端应用的附加参数,参数总长度在7000字符以下,应用中可以通过命令行参数直接获取到附加参数,命令行参数格式为:test.exe 参数值1 参数值2 ... taskkId .也通过接口调用获取参数,具体参见【获取请求附加参数】接口。参数传递在7000字符以上,必须调用获取参数接口 | | regionId | String | 可选 | 可以通过1.2.5 【获取当前系统所有渲染节点区域信息】取得regionId <br/>传入该参数,优先选择该区域下的渲染节点 | | groupId | String | 可选 | 通过1.8.1 获取当前系统所有渲染节点分组信息 <br/>传入该参数,仅选择该分组下的渲染节点 | | appKey | String | 可选 | 该参数为客户区分,在LarkSR3.2后台接入管理中设置,请参考后台管理功能介绍3.1接入管理。<br/>为空时,表示default区分 | | timestamp | Long | 可选 | 该参数为时间戳。当客户区分设置了密钥时,需要用到此参数。请参考后台管理功能介绍3.1接入管理。 | | signature | String | 可选 | 该参数为密钥签名。当客户区分设置了密钥时,需要用到此参数。生成方法:将appKey和appSecret(在LarkSR3.2后台接入管理中设置)和当前时间戳(long型数值)按字母序排序,然后进行SHA-1摘要签名。请参考【获取凭证签名】的样例。。 | | playerMode | String | 可选 | 启动模式:0:普通模式,1:演示模式,2:互动模式 <br/>一人操作多人观看的场景将playerMode设为1 | | userType | String | 可选 | 演示/互动模式下,用户类型:<br/>Task所有者:1 参与者:0 | | roomCode(3.2.21版本废弃) | String | 可选 | 演示/互动模式下,房间口令,<br/>对于Task创建者roomCode的生成方式参考1.2.6【生成口令】接口。<br/>对于观察者,口令由Task创建者告知 | | authCode(3.2.21版本新增) | String | 可选 | 演示/互动模式下,房间口令,<br/>对于Task创建者authCode的生成方式参考1.2.6【生成口令】接口。<br/>对于观察者,口令由Task创建者告知 | | nickname | String | 可选 | 演示/互动模式下,用户昵称。 | 说明: 1) 通过该接口URL跳转到客户端页面,会自动连接到LarkXR服务器展示服务器端的应用内容。因为需要页面跳转,不能通过Ajax调用,需要通过链接请求; 2) 是否传递TaskId:调用进入应用接口时如果想传递参数给应用程序,那么后台应用的配置页面上【是否传递TaskId】配置项,选择【是】,否则选择【否】。传递参数时,格式如下(注意:附加参数key必须以extraParam.开头): extraParam.userName=zhangsan&extraParam.age=12&……
pxy_ssl
2025年3月13日 19:20
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
开发者交流群
QQ群号:1011308692
Markdown文件
Word文件
PDF文档
PDF文档(打印)
分享
链接
类型
密码
更新密码
有效期