Im datasync

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


恩布用户集成数据同步手册

概述

文档说明

本文档,主要介绍企业用户集成数据同步的相关问题,帮助企业实现把企业用户数据,跟恩布协作平台的用户数据做同步,主要包括数据的导入和密码的同步;

本文档重点介绍企业用户数据同步的基本流程,以及使用哪个REST API,具体API使用指南,请查看 REST_API开发手册

REST API URL地址说明

恩布REST API所有的ebweblc.XXX接口地址格式如下:

http://server-ip/rest.v03.ebweblc.XXX?X=Y

server-ip:是服务器IP地址或域名,如test.entboost.com

XXX:表示函数接口名称,具体看接口文档介绍;

ebwebap.XXX、ebwebum.XXX地址由ebweblc.XXX接口调用返回;

验证、注册、登录功能

验证应用ID接口ebweblc.authappid

所有数据同步接口都需要验证应用ID,保证调用来源的合法性,验证应用ID成功,获取一个动态应用ID在线KEY(类似访问令牌),再通过该应用在线KEY,去访问其他的REST接口;

接口函数:ebweblc.authappid

注册用户ebweblc.regreq、ebwebum.reguser

注册个人用户和注册企业用户使用相同的注册接口,注册需要先申请后注册,二个接口流程:

注册申请接口:ebweblc.regreq

注册申请成功,会返回一个注册的REST URL地址,再通过该URL地址,调用以下接口实现注册用户功能;

注册用户接口:ebwebum.reguser

用户登录ebweblc.logonaccount、ebwebum.online

用户登录需要先验证,后登记用户在线,二个接口流程:

用户验证接口:ebweblc.logonaccount

用户验证成功,会返回一个登录的REST URL地址,再通过该URL地址调用以下接口实现用户登录功能;

用户上线接口:ebwebum.online

企业组织结构数据管理功能

概述

企业组织结构数据管理功能,需要使用企业管理员帐号,登录成功后才能正常操作;

本文档主要描述跟企业组织结构相关的接口,更多功能,请参考《ENTBOOST_SDK_API_REST.pdf》文档;

加载企业组织结构ebwebum.loadorg

加载登录用户所属企业组织结构,包括企业信息,部门信息,和员工信息等;

接口函数:ebwebum.loadorg

修改企业信息ebwebum.editent

修改企业信息;

接口函数:ebwebum.editent

编辑群组(部门)ebwebum.editgroup

新建或修改群组(部门)信息,支持新建和修改个人群组,公司部门和公司项目组信息;

接口函数:ebwebum.editgroup

删除群组(部门)ebwebum.deletegroup

删除群组(部门)信息,支持个人群组,公司部门和公司项目组信息;

接口函数:ebwebum.deletegroup

编辑部门员工(群组成员)ebwebum.editmember

新建或修改部门员工(群组成员)信息;

接口函数:ebwebum.editmember

删除部门员工(群组成员)ebwebum.deletemember

删除部门员工(群组成员)信息;

接口函数:ebwebum.deletemember

数据同步和回调机制

概述

数据同步和回调,实现企业与恩布协作平台之间的用户密码和新注册用户等数据的同步,相互实现修改;

该机制的接口属于服务端应用功能,直接应用验证调用,不需要用户管理;

同步修改用户密码ebwebap.synceditpwd

用于企业修改恩布协作平台上的企业员工密码,实现用户密码同步;

接口函数:ebwebap.synceditpwd

配置数据回调

配置用户数据回调接口(ebwebap.sysedit),包括回调的URL地址,接收回调的应用ID(加密密钥)和加密方式等;通过该配置,可以实现恩布平台上用户修改密码(或新注册用户),可以实现回调给企业,实现用户数据同步;

回调方式,统一使用HTTP POST方法;(原来旧版本使用GET方法)

回调数据支持不加密,和加密二种,加密算法支持:aes_ecb,aes_cbc,3des三种

具体看接口参数;

接口函数:ebwebap.sysedit

也可以通过恩布管理后台配置:如下图:

ENTBOOST User Data Sync 01.png

同步数据格式

同步数据类型:

type=1:用户修改密码同步数据;

type=2:新注册用户同步数据;

type=3:用户上下线状态通知数据;

type=1,用户修改密码同步数据:

非加密模式参数:

type=1&msgid=[消息ID]&uid=[用户ID]&account=[用户帐号]&old_pwd=[用户旧密码]&new_pwd=[新密码]

加密模式参数:

data=HEX(aes_ecb(type=1&msgid=[消息ID]&uid=[用户ID]&account=[用户帐号]&old_pwd=[用户旧密码]&new_pwd=[新密码]))

HEX表示,aes_ecb加密后,二进制数据,转十六进数据显示;

回调URL,接收到恩布协作平台的回调事件,需要返回消息ID给恩布协作平台;

type=2,新注册用户同步数据:

非加密模式参数:

type=2&msgid=[消息ID]&uid=[用户ID]&account=[用户帐号]&reg_code=[注册用户激活代码]&username=[用户名称]&entname=[企业名称,空为个人用户,可选]

加密模式参数:

data=HEX(aes_ecb(type=2&msgid=[消息ID]&uid=[用户ID]&account=[用户帐号]& reg_code=[注册用户激活代码]&username=[用户名称]&entname=[企业名称,空为个人用户,可选]))

HEX表示,aes_ecb加密后,二进制数据,转十六进数据显示;

回调URL,接收到恩布协作平台的回调事件,需要返回消息ID给恩布协作平台;

type=3,用户上下线通知数据:

非加密模式参数:

type=3&msgid=[消息ID]&uid=[用户ID]&account=[用户帐号]& visitor=[是否游客 0/1]&logontype=[用户登录终端,详见附录]&state=[用户在线状态,详见附录]&time=[在线状态时间,格式YYYY-mm-DD HH:MM:SS.ms]

加密模式参数:

data=HEX(aes_ecb(type=3&msgid=[消息ID]&uid=[用户ID]&account=[用户帐号]& visitor=[是否游客 0/1]&logontype=[用户登录终端,详见附录]&state=[用户在线状态,详见附录]&time=[在线状态时间,格式YYYY-mm-DD HH:MM:SS.ms]))

HEX表示,aes_ecb加密后,二进制数据,转十六进数据显示;

回调URL,接收到恩布协作平台的回调事件,需要返回消息ID给恩布协作平台;

请求重发错误同步数据ebwebap.sysedit

正常网络通讯情况下,如果恩布发送回调同步数据给企业后,收不到消息ID返回,恩布协作平台会连续重发五次后,保留7天有效时间,在这7天有效时间以内,企业可以请求重发这些错误回调同步数据;

具体看接口参数;

接口函数:ebwebap.sysedit

如果企业URL系统故障,回调数据,恩布协作平台最长保留30天;

附录

在线状态

typedef enum EB_USER_LINE_STATE
{
    EB_LINE_STATE_UNKNOWN      = 0
    , EB_LINE_STATE_RESERVE    = 1    // 保留(旧版本在线状态)
    , EB_LINE_STATE_OFFLINE    = 2    // 离线
    , EB_LINE_STATE_BUSY       = 3    // 忙
    , EB_LINE_STATE_AWAY       = 4    // 离开
    , EB_LINE_STATE_ONLINE     = 5    // 在线(新)
};

登录类型

typedef enum EB_LOGON_TYPE
{
    , EB_LOGON_TYPE_PC        = 0x0000100
    , EB_LOGON_TYPE_IOS       = 0x0000200
    , EB_LOGON_TYPE_ANDROID   = 0x0000400 
    , EB_LOGON_TYPE_WP        = 0x0000800
    , EB_LOGON_TYPE_WEB       = 0x0001000
    , EB_LOGON_TYPE_SERVER    = 0x0010000    // 服务端登录,不处理IM业务
    , EB_LOGON_TYPE_PUSHAPP   = 0x0020000    // 消息推送应用
};

文档版本说明

版本日期 作者 内容
2014-07-28 HD 文档初稿。
2014-08-01 HD 增加用户密码回调同步机制
2015-03-12 HD 用户密码回调同步机制,增加支持注册新用户同步回调;
2015-07-16 HD 完善统一数据同步机制,增加用户上下线状态通知数据;
2015-07-27 HD 配置数据回调增加管理后台配置界面,修改部分错误文字描述;