IM Integration

来自恩布企业IM,协作平台文档
跳转至: 导航搜索


恩布应用集成开发手册

目录

概述

文档说明

本文档主要介绍企业应用功能开发的相关问题,帮助企业实现开发应用和集成企业其他系统(如OA,CRM)到恩布协作平台客户端界面上;具体API使用指南,请查看《ENTBOOST_SDK_API_REST.pdf》文档;

通过本文档学习,企业可以利用相关的接口,基于恩布协作平台,实现各种应用功能的开发和集成,以及给IM客户端发送广播消息。

**本文档所有功能可以通过恩布互联管理中心,不需要开发,直接配置管理,详细看 REST_API开发手册

应用功能介绍

应用功能概念

恩布协作平台支持集成各种网页(Web页面),本地应用程序等,支持单点登录验证等功能;

应用功能页面支持使用恩布协作平台前端功能标签;

应用功能显示方式

使用应用工作区打开网页应用

点击或选择某个集成应用功能入口,如下图:

ENTBOOST Application Integration Development V1 0 01.png

使用对话框窗口打开网页

对话框窗口打开网页,支持对话框窗口和窗口模式二种,(对话框模式表示打开界面显示在最上层,输入完成操作关闭才才能进行其他操作;窗口模式,表示打开的窗口可以一直存在,用户可以自由切换到其他的界面上做操作),如下图:

ENTBOOST Application Integration Development V1 0 02.png

使用浏览器打开网页

点击或选择某个应用功能入口,直接使用默认浏览器打开网页,如下图:

ENTBOOST Application Integration Development V1 0 03.png

选择恩布互联应用功能入口,直接跳转到恩布互联网站地址上:

ENTBOOST Application Integration Development V1 0 04.png

调用本机应用程序

**集成本地应用程序,支持不带参数和带帐号信息参数二种,带参数格式:app.exe uid account

点击或选择某个集成应用功能入口,如下图:

ENTBOOST Application Integration Development V1 0 05.png

该"记事本"是集成打开本地的一个记事本程序(notepad.exe),选择打开记事本:

ENTBOOST Application Integration Development V1 0 06.png

应用功能入口集成位置

集成到应用工作区

把应用功能集成到恩布协作平台主界面应用工作区,类似下图:

ENTBOOST Application Integration Development V1 0 07.png

集成到主界面下面单独按钮位置

把应用功能集成到恩布协作平台主界面下面单独按钮,类似下图:

ENTBOOST Application Integration Development V1 0 09.png

集成到主界面右键菜单位置

把应用功能集成恩布协作平台主界面右键菜单,右键主界面任意位置右键,弹出协同功能菜单,类似下图:

ENTBOOST Application Integration Development V1 0 10.png

集成到用户列表右键菜单位置

把应用功能集成到用户列表右键弹出菜单位置,类似下图:

ENTBOOST Application Integration Development V1 0 11.png

集成到聊天界面按钮位置

把应用功能集成到恩布协作平台聊天界面上按钮,类似下图:

ENTBOOST Application Integration Development V1 0 12.png

集成到聊天记录窗口位置(采集聊天内容数据)

把应用功能集成聊天记录窗口的右键菜单,选择聊天记录然后右键选中聊天内容,弹出应用功能菜单,类似下图:

**目前采集聊天内容数据只支持客户端窗口方式,并且一次支持最长2048字节(2K)内容,超过的内容会被截断;

ENTBOOST Application Integration Development V1 0 13.png

应用功能页面参数

没有参数方式

用户客户端打开应用功能页面,不带任何参数,直接打开企业设计URL页面;如下例子:

http://www.entboost.com/

默认恩布参数方式

用户客户端打开应用功能页面,带authid&fk&ums指定参数,直接打开企业设计URL页面;默认恩布参数方式,需要跟恩布后台对位,安生性最好;详细看后面介绍;如下例子:

http://server-ip/your-app-url?authid=xxx&fk=xxx&color=xxx&ums=xxx

转发参数。

参数 默认值(非空) 描述
authid   验证ID
通过该验证ID,访问恩布用户管理后台,验证用户合法性,验证成功返回用户相关信息。
fk   验证KEY
fk=md5([eb_fk_v1]authid;user_ip_address;appid)
color   [可选]PC端界面主色调颜色
格式:rrggbb,例如:ff0000(红色)
ums   用户管理服务器IP地址
通过该地址可以验证用户请求合法性,验证成功返回用户相关信息;

应用功能后台收到转发请求URL,需要先验证fk合法性,才能进行下一步操作;

fk验证方法例子:

fk=md5([eb_fk_v1]6327250900812100;192.168.1.112;278573612908)

fk=8379bb31da7868f3e4f3a7efaedacc01

跳转URL例子:

http://forum.entboost.com/forum.php?authid=6327250900812100&fk=ae4f471644d33134400a99ea5debc6eb&ums=192.168.1.12:18112

用户信息参数方式

用户客户端打开应用功能页面,带uid&account&color&ok四个用户参数,打开企业设计URL页面,这种方式,直接取出用户ID(uid)、用户帐号(account)、PC客户端主色调颜色(color)和登录在线KEY(ok),企业不需要跟恩布后台对接;如下例子:

http://www.entboost.com/eb?uid=80&account=admin&color=ff0000&ok=xxx

集成本地程序带帐号参数格式:APPNAME UID ACCOUNT,如下例子:

APP.exe 88056 test@entboost.com

使用参数变量

集成应用URL支持使用参数变量,变量如下列表:

变量名称 变量描述
${USER_ID} 用户编号,如系统管理员UID:80
${USER_ACCOUNT} 用户帐号,如admin
${USER_NAME} 用户名称
${MOBILE} 手机号码
${TEL} 联系电话
${EMAIL} 邮箱地址
${ADDRESS} 用户住址

变量使用例子:

设置URL为:http://www.entboost.com/eb?user_account=${USER_ACCOUNT}

用户访问后:http://www.entboost.com/eb?user_account=admin

用户访问应用功能流程图

企业员工请求访问某个应用功能入口时,会先通过恩布协作平台验证,验证成功后再跳转到应用功能入口URL,并带上相关的URL参数,应用功能后台,需要根据URL参数访问恩布协作平台验证用户请求合法性,验证成功返回用户信息;

ENTBOOST Application Integration Development V1 0 14.png

如何添加集成应用功能

使用系统管理员帐号,登录恩布管理后台添加应用功能,详细看恩布协作平台管理后台使用手册:《ENTBOOST_Management_Center_Manual.pdf》。

广播消息(消息通知)介绍

广播消息概念

恩布协作平台支持通过接口,给企业、群组(部门)、或用户发送广播消息,企业利用该广播消息接口可以实现各种流程处理等通知。

广播消息支持标准HTML代码,同时支持恩布协作平台前端功能标签;

广播消息显示位置

广播消息默认显示在系统桌面右侧的位置,如下图:

ENTBOOST Application Integration Development V1 0 15.png

恩布协作平台前端功能标签

概述

恩布协作平台前端功能标签,是一种网页页面与客户端程序交互技术,利用恩布协作平台前端功能标签,帮助企业在开发的应用功能页面、和广播消息中,实现类似发起单聊、群聊、申请好友等功能请求;

恩布协作平台前端功能标签,所有集成到客户端窗口的应用,都支持该功能标签。

发起单聊功能

功能说明

在应用功能页面和广播消息中,发起一个单聊功能请求,请求成功会打开聊天界面。

标签格式

标签命令:ebim-call-account://[to_account]

标签格式:<a href="ebim-call-account://[to_account]">发起会话</a>

使用例子

发起邮箱用户聊天:<a href="ebim-call-account://test@entboost.com">点击聊天</a>

发起手机用户聊天:<a href="ebim-call-account://1581001111">点击聊天</a>

发起用户ID聊天:<a href="ebim-call-account://80">点击聊天</a>

发起900客服号码聊天:<a href="ebim-call-account://9009301111">点击聊天</a>

ENTBOOST Application Integration Development V1 0 16.png

发起群聊功能

功能说明

在应用功能页面和广播消息中,发起一个群聊(群组或部门聊天)功能请求,请求成功会打开聊天界面。

标签格式

标签命令:ebim-call-group://[groupid]

标签格式:<a href="ebim-call-group://[groupid]">群组聊天</a>

使用例子

发起群组(部门)聊天:<a href="ebim-call-group://888001">群组聊天</a>

ENTBOOST Application Integration Development V1 0 17.png

打开本地程序或文件

功能说明

在应用功能页面和广播消息中,请求打开本地程序或文件。

标签格式

标签命令:eb-open-file://

标签格式:<a href="eb-open-file://[file-name]">打开程序或文件</a>

使用例子

打开本地记事本程序:<a href="eb-open-file://notepad.exe">记事本</a>

打开本地WORD程序:<a href="eb-open-file://winword.exe">新建WORD文档</a>

ENTBOOST Application Integration Development V1 0 18.png

打开应用窗口

功能说明

在应用功能页面和广播消息中,请求打开恩布客户端窗口,支持指定尺寸、全屏打开指定网站地址。

标签格式

标签命令:eb-open://

标签格式:<a href="eb-open://[width,height,url]">打开窗口</a>

width,height:指定客户端窗口宽度和高度,0表示全屏打开。

url:要打开的链接,支持全路径和相对路径,如" /product"。

使用例子

打开窗口恩布互联网站:<a href="eb-open://720,680,http://www.entboost.com">恩布互联</a>

全屏打开恩布互联网站:<a href="eb-open://0,0,http://www.entboost.com">恩布互联</a>

打开应用窗口2

功能说明

更加功能参数的,打开恩布客户端窗口。

标签格式

标签命令:eb-open2://

标签格式:<a href="eb-open2://[width,height,disablecontentmenu,disablescrollbar,closeprompt,opennewclose,winresizable,url]">打开窗口</a>

width,height:指定客户端窗口宽度和高度,0表示全屏打开。

disablecontentmenu:是否屏蔽鼠标右键菜单,0/1。

disablescrollbar:是否屏蔽页面滚动条,0/1。

closeprompt:关闭窗口是否提示退出确认框,0/1。

opennewclose:打开新窗口是否关闭当前窗口,0/1。

winresizable:客户端窗口大小是否可拉伸,0/1,设置1可拉伸窗口同时有最大化按钮。

url:要打开的链接,支持全路径和相对路径,如" /product"。

使用例子

打开窗口恩布互联网站:<a href="eb-open2://720,680,http://www.entboost.com">恩布互联</a>

全屏打开恩布互联网站:<a href="eb-open2://0,0,http://www.entboost.com">恩布互联</a>

关闭应用窗口

功能说明

在应用功能页面和广播消息中,请求关闭当前窗口。

标签格式

标签命令:eb-close://

标签格式:<a href="eb-close://">关闭窗口</a>

申请加为好友(联系人)

功能说明

在应用功能页面和广播消息中,请求申请添加添加(联系人)。

标签格式

标签命令:eb-add-contact://

标签格式:eb-add-contact://[联系人用户ID],[验证备注信息,备注信息不能带','可以为空]

使用例子

添加好友:<a href="eb-add-contact://888035,请加我为好友">加为好友</a>

退出应用程序

功能说明

退出恩布客户端应用程序;

标签格式

标签命令:eb-exit-app://

标签格式:<a href="eb-exit-app://">退出</a>

注销用户

功能说明

退出当前登录用户状态,并重新启动,用于切换用户;

标签格式

标签命令:eb-logout://

标签格式:<a href="eb-logout://">注销</a>

显示主界面

功能说明

显示主界面;

标签格式

标签命令:eb-show-mainframe://

标签格式:<a href="eb-show-mainframe://">注销</a>

隐藏主界面

功能说明

隐藏主界面;

标签格式

标签命令:eb-hide-mainframe://

标签格式:<a href="eb-hide-mainframe://">注销</a>

打开集成应用

功能说明

打开集成应用,支持带参数;

标签格式

标签命令:eb-open-subid://

标签格式:<a href="eb-open-subid://[应用订购ID] [,是否打开新窗口0/1,默认1打开新窗口] [,XXX参数]">集成应用名称</a>

应用开发接口

概述

开发应用功能跟恩布协作平台打交道,只需要二个接口,一个验证应用ID接口,一个获取用户信息接口;应用功能开发完成,通过恩布管理后台配置应用功能入口后,即可使用。

广播消息发送接口也需要二个接口,一个验证应用ID接口,一个发送广播信息接口;广播消息发送属于接口调用,不需要配置。

验证应用ID接口ebweblc.authappid

应用ID用于标识某个应用功能,应用ID使用前需要验证一次,验证成功会返回app_online_key(应用在线KEY),通过该应用在线KEY可以进行后继操作。

接口函数:ebweblc.authappid

获取用户信息接口ebwebum.fauth

用户访问应用入口,恩布协作平台验证访问合法性,验证成功跳转到应用功能后台,应用功能后台拿到恩布协作平台跳转的URL,取出相应参数,通过该接口验证用户访问请求合法性,验证成功返回用户相关信息;

接口函数:ebwebum.fauth

发送广播消息接口ebwebap.sendbcmsg

验证成功应用ID,可以利用该接口发送广播消息,支持发送给整个企业、群组(或部门)、或个人用户;

发送对象优先处理顺序:to_account->to_group_id->to_enterprise_code,三个参数,必须填写一个;

接口函数:ebwebap.sendbcmsg

应用功能入口管理接口

概念

应用功能开发完成,通过应用功能管理接口,实现应用功能入口配置;企业员工登录成功就会自动加载到恩布协作平台的客户端。

加载应用功能列表ebwebum.fload

加载企业(或某个APP)的应用功能列表,支持分页功能,详细看接口参数说明;

接口函数:ebwebum.fload

添加或修改应用功能ebwebum.fedit

添加或修改某条应用功能入口信息;

成功添加应用功能,还需要调用企业订购该条应用功能,才算完成一条应用功能的配置;

接口函数:ebwebum.fedit

设置应用功能显示图标ebwebum.fseticon

设置应用功能显示图标;

接口函数:ebwebum.fseticon

企业或个人订购应用功能ebwebum.fsub

企业或个人订购应用功能,订购成功,用户客户端登录,就会自动加载到客户端界面。

接口函数:ebwebum.fsub

删除应用功能ebwebum.fdel

删除一条应用功能入口信息。

接口函数:ebwebum.fdel

定制登录窗口功能接口

定制管理接口ebwebap.sysedit

通过定制登录窗口功能接口,可以实现包括是否开放用户注册、是否开放游客登录、登录窗口企业LOGO和忘记密码按钮等功能,并且在恩布协作平台客户端界面会显示相应的功能按钮;

**该功能接口仅提供给授权企业用户使用。

接口函数:ebwebap.sysedit

文档版本说明

版本日期 作者 内容
2014-06-20 HD 文档初稿。
2014-08-07 HD 增加应用功能管理接口。
2014-08-12 HD 增加采集聊天记录内容数据功能;
2014-08-22 HD 增加定制登录窗口界面功能,包括开放注册、游客登录、企业LOGO和忘记密码等;
2014-09-29 HD 增加打开恩布客户端窗口功能标签;部分接口描述完善。
2014-10-15 HD 1.应用功能显示位置增加主界面下面单独按钮;
2.增加ebwebum.fseticon接口;
3.增加设置不同应用功能参数方式等功能;
2014-11-07 HD 增加集成本地应用程序、打开本地文件功能;
2014-11-20 HD 1.增加关闭客户端页面提示配置功能,详细看ebwebum.fedit和ebwebum.fload增加。
2.默认打开应用功能,增加color颜色参数。
2014-11-29 HD 1.增加eb-open2://标签。
2.增加支持打开相对路径URL功能,如"/product"
2015-01-21 HD 增加eb-add-contact://添加联系人标签;
2015-08-20 HD PC端,增加注销,退出,隐藏,显示标签;
增加集成应用工作区;
2015-08-27 HD 集成应用URL,增加变量参数;
2015-11-05 HD PC端,增加eb-open-subid 打开应用标签功能;
集成应用URL,增加支持${USER_ID},${USER_ACCOUNT},${USER_NAME},${MOBILE},${TEL},${EMAIL},${ADDRESS}参数;
2015-11-13 HD 去掉帐号验证章节描述,详见《ENTBOOST_SDK_API_REST_V03.pdf》文档。
2016-07-11 HD eb-open-subid:// 标签,增加参数
2016-09-03 HD 根据最新V1.22版本,美化部分功能界面截图;