猿大师中间件腾讯软件内嵌网页小程序开发文档

猿大师中间件腾讯软件内嵌网页小程序开发原理：

 

猿大师中间件腾讯软件（微信/QQ等）内嵌网页小程序是基于猿大师中间件网络版开发，可实现将腾讯微信、企业微信、腾讯会议、QQ等客户端软件内嵌到网页中运行。最低可用在Chrome 41、Firefox 50、Edge 80(Chromium内核)、360极速/安全、IE 8、Oprea 36、QQ、搜狗等浏览器，也兼容运行于这些浏览器的最新版本。

 

1.猿大师中间件腾讯软件内嵌网页小程序的安装步骤：

 

1)、如果是exe的安装程序，请直接运行安装；

2)、如果是绿色版的程序包，请解压到磁盘某个目录后，双击“InstallWrl.bat”进行安装；

3）、安装完成时会启动猿大师中间件服务，在安装目录下的Data子目录有ZbaService.txt日志文件输出运行情况。

 

2.猿大师中间件腾讯软件内嵌网页小程序控制相关接口：

 

说明：以下功能请通过Web Socket连接猿大师主服务(ws://localhost:83?sid=12345&flag=1)后可执行，如默认侦听端口不是83(关于如何配置侦听端口，请参考SDK包中的文档“PluginOK开发者手册.doc”)，请在连接地址中指定端口号进行连接。

 

HTTP网页在线测试：http://test.yuanmaster.com/txfull.html  

HTTPS网页在线测试：https://test.yuanmaster.com/txframe.html

 

前端集成可参考以上测试网页进行，HTML网页中需要嵌入以下类似代码；

A、标记程序的显示位置和大小

.TXWebApplet {

            margin: 20px 0 0 20px;

            width: 480px;

            height: 320px;

            border: 1px solid blue;

        }

或者

.TXWebApplet {

            width: 480px;

            height: 320px;

            top: 20px;

            left: 20px;

            border: 1px solid blue;

        }

如果在网页Header区没有标记小程序初始显示位置和大小，请在启动小程序的JSON参数里，添加以下参数：

"Left":20,"Top":20,"Width":480,"Height":320

 

B、网页中嵌入元素

支持IFrame的：

<iframe name="TXWebApplet" id="TXWebApplet" src="TXApplet3.html" frameborder="0" align="left" width="550" height="540" scrolling="no">

或者直接用

<div id="TXWebApplet" class="TXWebApplet"</div>

 

另外需要嵌入用到的JS脚本，脚本程序是完全开源的。

 

1)、请求启动腾讯软件内嵌网页版实现网页中局部加载显示：

Type为浏览器类型，传0自动判断(前提是当前浏览器已启动并显示在最前端，Flag指定当前页加载时必须是0) 可强制指定浏览器类型Type(2代表Chrome 4代表Firefox 8代表Opera 16代表Edge(Chromium内核) 32代表360极速浏览器 33代表360安全浏览器 34代表360企业安全浏览器 50代表QQ浏览器 60代表搜狗浏览器)

Title：网页标题中的关键词

Flag掩码标记：1指定新标签加载(1和16都不指定时为当前页加载) 2小程序显示窗口边框 4不自动裁剪越界窗口 8自动适配网页高度和宽度显示  64根据标题避免重复加载相同的小程序

IframeX和IframeY分别为iframe嵌套的横竖偏移修正坐标

BarW和BarH分别是网页右侧和底部预留区域

小程序实际显示首先会基于网页中指定的坐标和大小，再根据IframeX、IframeY、BarW、BarH设定的值做修正

App 指定加载软件，0微信桌面版 1企业微信桌面版 2腾讯会议桌面版

Url：加载小程序所在的网页实际地址

注意：Url如果有特殊字符或中文等，需要用URL编码处理后传递

 

举例：

自动识别当前浏览器指定位置和大小启动：

{"req":"Wrl_TXWebApplet","rid":1,"para":{"Type":"0","Title":"Tencent Web Applet","Flag":2,"App":"0"","IframeX":0,"IframeY":0,"BarW":0,"BarH":0,"Url": "http://zorrosoft.com/TXApplet.html"}}

 

自动识别当前浏览器指定位置自动适配网页大小启动：

{"req":"Wrl_TXWebApplet","rid":2,"para":{"Type":"0","Title":"Tencent Web Applet","Flag":10,"App":"0"","IframeX":0,"IframeY":0,"BarW":0,"BarH":0,"Url": "http://zorrosoft.com/TXApplet.html"}}

 

当前页指定位置自动适配网页加载测试

http://zorrosoft.com/txframe.html

 

启动后会先后收到三个JSON数据包

A、{"ret":0,"rid":1,"data":{"ID":3}}

代表小程序WS侦听服务就绪

B、{"event":"Wrl_Listen","aid":3,"data":{"SID":"123","PID":"TXWebApplet","port":955}}

返回的侦听端口，可再建立一个Web Socket连接后，调用小程序中的相关功能。

代表小程序创建成功，返回ID为当前小程序运行ID，通过此ID，可执行Wrl_AppletControl、Wrl_AppletScroll、Wrl_AppletResize等命令。

C、{"event":"Wrl_AppletOK","aid":3,"data":{"SID":"123","PID":"TXWebApplet","Port":955}}

 

2)、请求控制腾讯软件内嵌网页版：

当前端不再需要小程序时可指定关闭，或者显示/隐藏及全屏显示等

ID为启动小程序时返回JSON中的ID值，Code代表控制类型掩码：1关闭 2全屏显示 4自动隐藏 8还原显示 16自动适配网页高度和宽度显示模式切换 32强制隐藏。其中全屏显示2，可直接通过热键ESC或取消,4和32隐藏后可通过8恢复显示

{"req":"Wrl_AppletControl","rid":2,"para":{"ID":"1","Code":4}}

 

3)、请求滚动腾讯软件内嵌网页版：

当前端截取到网页滚动通知时，需要调用此接口实现小程序和网页的滚动联动

ID为启动小程序时返回JSON中的ID值

Code为滚动方向1是水平直，2是垂直，3是同时

Left为横向滚动条位置，Top为纵向滚动条位置

{"req":"Wrl_AppletScroll","rid":3,"para":{"ID":"1","Code":2,"Left":0,"Top":100}}

 

4)、请求改变腾讯软件内嵌网页版显示位置或大小：

当前端网页显示区域缩放时，可动态修改小程序的显示位置或大小

ID为启动小程序时返回JSON中的ID值，Width和Height分别为新的宽度和高度，X和Y分别为新的显示位置，不指定时保持不变，指定时原设置的IframeX和IframeY失效

{"req":"Wrl_AppletResize","rid":4,"para":{"ID":1,"Width":500,"Height":600}}

或同时设置小程序显示起始坐标

{"req":"Wrl_AppletResize","rid":5,"para":{"ID":1,"Width":500,"Height":600,"X":20,"Y":20}}

 

5)、请求设置网页预留右侧宽度和底部高度，滚动条信息、垂直滚动及水平滚动位置：

当小程序显示区域超过当前网页时，需去除滚动条的显示影响

ID为启动小程序时返回JSON中的ID值，BarW为预留右侧宽度 BarH为预留底部高度

Code 1代表有水平滚动条，2代表有垂直滚动条，3代表都有

ScrollTop垂直滚动条位置 ScrollTop水平滚动条位置

{"req":"Wrl_ScrollBar","rid":6,"para":{"ID":"1","Code":2,"BarW":0,"BarH":0,"ScrollTop":0,"ScrollLeft":0}}

 

6)、请求对小程序窗口做Alpha透明处理，便于前端临时显示覆盖到小程序窗口的菜单等：

ID为Wrl_TXWebApplet启动小程序时返回的ID值，Alpha为透明度百分比，1-100

{"req":"Wrl_AppletAlpha","rid":7,"para":{"ID":1,"Alpha":30}}

 

7)、请求对小程序窗口内容进行截图：

ID为启动小程序时返回JSON中的ID值，

File为指定截图文件保存路径或扩展名

Base64指定为1时代表返回BASE64编码的图像内容

{"req":"Wrl_AppletSnap","rid":10,"para":{"ID":1,"Base64":1,"File":".png"}}

 

8)、请求缩放IE控件内嵌网页小程序，用于浏览器网页按比例缩放，一般不需要处理：

ID为启动小程序时返回JSON中的ID值，Scall为缩放百分比

{"req":"Wrl_AppletScale","rid":11,"para":{"ID":1,"Scale":120}}

 

3、小程序安装、升级、卸载

1)、请求安装腾讯软件内嵌网页版

请在输入框中，输入如下请求，然后点击发送，完成安装：

 

{"req":"Plugin_Install","rid":1,"para":{"Name":"腾讯软件内嵌网页版","PID":"TXWebApplet","Date":"2021-03-27","Desc":"猿大师之上跨浏览器的腾讯微信、企业微信、腾讯会议等桌面软件内嵌网页版，支持在Chrome、Edge、Firefox、IE、Oprea、360、QQ等浏览器网页中直接内嵌使用，和B/S信息化系统融为一体使用","DownAddr":"http://local.zorrosoft.com/Files/Net/TXWebApplet.pid","MD5":"40452385A1A992B68ECB4C987C0A2E5B","Version":"2.1.3.1","Size":491520,"HideIns":0,"Type":8,"Cookie":"","Auth":"","TK":"6D1C3650DD81CD237634DBECA0D02838418AD810B0B6E70D99450FE3DFE9E6DAEE2EF30BDE648DCFF7FBF155D130ADC2637CF99C527DDF6C828A29EF91743F48A8B9BB28E9455478A5192C6FC7FF2856A615034A83A9E8A1ECB0327B4F3081F43A7A7005C6E32AEF5F09EE4553CC82CB79972E2F1F6826BB0429DB9491B5892A29822FDF24C2FCC141B9C6437EAC06CA72BDA10AE2990FE50DBE1DD640634FD3FC00B0255E308C4AA683FCB6360259A1CD269C00265D7D2D85841B1D25B863F12F053FDE1AAAAB1D69B96561549FC674C6D99C93DEE0CBFD60D93B093A3F3195ACA9C1B181F3E1A1760A56DB572E7F77111C047883A3BA9BE7BFD2112A0C07D9"}}

 

启动安装后，会不断收到安装进度直到安装结束。

在发布时，也可以把此小程序目录文件和中间件一起打包后发布，不用单独分发。

 

2)、请求升级腾讯软件内嵌网页版：

 

{"req":"Plugin_Update","rid":1,"para":{"Name":"腾讯软件内嵌网页版","PID":"TXWebApplet","Date":"2021-03-27","Desc":"猿大师之上跨浏览器的腾讯微信、企业微信、腾讯会议等桌面软件内嵌网页版，支持在Chrome、Edge、Firefox、IE、Oprea、360、QQ等浏览器网页中直接内嵌使用，和B/S信息化系统融为一体使用","DownAddr":"http://local.zorrosoft.com/Files/Net/TXWebApplet_Update.pid","MD5":"577129948380E2226CF1DC7DBDF3497F","Version":"2.1.3.1","Size":491520,"HideIns":0,"Type":8,"Cookie":"","Auth":"","TK":"935EE3B11DBAF617E605A826B7881E9CF01D570217B8A5B8EBB915DB222113B8CEF355F47F188846C4F96820EA2A013F9C7D0F30389A46858B806B4999915AF86833C49F619FBE01DBA7950AEEA29B97C61DE5740C11EB69D20DB0E7A28664DC143FF2C53BCB166FAC6734B4244D8EA4842EF7F2F83EE5788DC1F2681A304F5B31A1E19EEA842ED431E1EA579D807DE70B1878E108B3B9476EF01C037761073EDA15C956D61476FF46257C529DF77429D7A2355A1A72D258CEF5EE2A01186E09899EBFD8FBF9D80289D69D248BD84DE57AE0DA675A0F6FCD3C634F4407E9BF96E09B14800EFE24D491356309E793F4FF32D98969CF9F90D93DB9D3D100A2FF6E"}}

 

以上安装和升级的JSON请求包，可能因版本升级导致内容不同，如遇安装或升级时报错，请联系客服获取最新的请求包。 

 

3)、请求卸载腾讯软件内嵌网页版：

 

{"req":"Plugin_Remove","rid":3,"para":{"PID":"TXWebApplet","Type":8}}

 

4、腾讯软件内嵌网页版转调用接口，先根据Wrl_TXWebApplet请求启动后返回的端口号，新建立一个WebSocket连接后可执行如下指令：

 

1) 请求退出小程序

请求：{"req":"TXApp_Exit","rid":50,"para":{}}

 

5、猿大师支持的事件通知：

 

1) TXAPP_FullScreen 小程序是否响应了热键全屏

{"event":"TXAPP_FullScreen","data":{"FullScreen":0}} FullScreen为当前是否全屏标记

 

2) Wrl_AppletExit 小程序退出通知

{"event":"Wrl_AppletExit","data":{"ID":1}}

 

6、其它

请求参数的JSON数据包，请确保是UTF-8无签名的编码。

更多接口请求说明，请参考安装目录中的文档TestWrl.txt、SDK包中的“猿大师开发者手册.doc”及“猿大师中间件安全解决方案”。

如还有疑问请直接联系客服。