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.3 获取进入应用URL
**1.2.3 获取启动应用URL** **注意:在启动应用时候调用,获取到URL后立即访问,否则会超时而失效 ** | 请求方式 | GET | | ------------ | ------------ | | **请求URL** | http: // {LarkXR3.2管理服务器IP}:8181/appli/getStartURL | **升级说明** - 接口地址由 “/getEnterAppliURL”变更为“/appli/getStartURL” - 3.2.21版本开始,参数"roomCode"字段,变更为"authCode" **参考样例 ** ``` 说明:appKey,timestamp,signature这三个参数有两种方式传递 一种是以参数的形式传递,例如:http://192.168.0.55:8181/appli/getStartURL?appKey=Jx5MQoo1& timestamp=1585729005673&signature=4C1BFE264A113A99C526BF5565EEBE642792A0B6&appliId=712678695067713536&codeRate=8000&frameRate=30 另一种是在OkHttp请求的header中传递,例如 : Request.Builder builder = new Request.Builder(). addHeader("appKey", "Jx5MQoo1") .addHeader("timestamp", "1585729005673") .addHeader("signature", "4C1BFE264A113A99C526BF5565EEBE642792A0B6") .url(apiUrl); ``` |名称 | 类型 | 是否必须 |描述| | ------------ | ------------ | ------------ |------------ | | appliId | Long | 必须 | | | codeRate | Int | 可选 | 参见1.2.2 | | frameRate | Int | 可选 | 参见1.2.2 | | extraParam.XXX | String | 可选 | 参见1.2.2 | | regionId | String | 可选 | 参见1.2.2 | | groupId | String | 可选 | 参见1.2.2 | | appKey | String | 可选 | 参见1.2.2| | timestamp | Long | 可选 | 参见1.2.2 | | signature | String | 可选 | 参见1.2.2| | playerMode | String | 可选 | 参见1.2.2 | | userType | String | 可选 | 参见1.2.2 | | roomCode(3.2.21版本废弃) | String | 可选 | 参见1.2.2 | | authCode(3.2.21版本新增) | String | 可选 | 参见1.2.2 | | nickname | String | 可选 | 参见1.2.2 | 返回结果: |名称 | 类型 | 是否必须 | 描述 | | ------------ | ------------ | ------------ | ------------ | |code | Integer | 是 | 返回状态 | |message | String | 否 |返回消息 | | result | String | 否 |返回进入应用的URL | **返回示例** ``` { "code": 1000, "result": "/webclient?appliId=879408743551336448&taskId=885538846769414144&taskStatus=0&network=1&codeRate=8000&frameRate=30&renderServerIp=192.168.0.28&renderServerPort=10002&preferPublicIp=&groupId=null&serverId=879407242258939904&wsProxy=1&initWinSize=0&initCursorMode=0&fullScreenMode=0&bgColor=&mobileForceLandscape=1&mobileVirtualJoystick=1&useGamepad=0&mouseZoomDirection=1&playerListToggle=1&noOperationTimeout=0&touchOperateMode=mouse&logLevel=warn&rttLimit=60&rttLimitInterval=20&language=zh-CN&random=1631170513684" ``` 获取到进入应用的URL后,通过URL进入应用,比如将URL赋给iframe的src,在iframe中打开展示应用界面。 当LarkXR的Web客户端嵌入到iframe中使用时,可以在iframe外层通过Javascript监听获取LarkSR Web客户端发出的状态消息。监听的代码示例如下: ``` window.addEventListener("message", function(e) { console.log("receive message." + e.data.prex, e.data.type, e.data.message); }, false); ``` 其中 data 的数据格式为: ``` data: { "prex":"pxymessage", // 消息的前缀。固定为 pxymessage。 "type":"100", // 消息类型。 "message":"连接信令服务器成功" // 消息的文字说明。 } ``` 消息详情请[下载](https://www.pingxingyun.com/devCenter.html "下载")查看【数据通道_与客户端通信demo】
pxy_ssl
2025年3月13日 19:20
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
开发者交流群
QQ群号:1011308692
Markdown文件
Word文件
PDF文档
PDF文档(打印)
分享
链接
类型
密码
更新密码
有效期