263EM企业应用用户管理接口规范.docx
《263EM企业应用用户管理接口规范.docx》由会员分享，可在线阅读，更多相关《263EM企业应用用户管理接口规范.docx（9页珍藏版）》请在冰豆网上搜索。
263EM企业应用用户管理接口规范
263EM企业应用用户管理接口规范
版本1.0
文档编号：
PDD11000103-001
版权所有©1998-2018263网络通信
公司网址：
版权申明
本文档包含了来自263网络通信股份有限公司的机密技术和商业信息，这些信息作为263网络通信股份有限公司专用。
接受本文档即视为表示同意对其内容保密，并且未经263网络通信股份有限公司书面许可，不得复制、泄露或散布本文档的全部或部分内容。
本文档及其描述的内容及产品的著作权和版权受有关法律保护，对本文档内容的任何形式的非法复制，泄露或散布，将导致承担相应的法律责任。
263网络通信股份有限公司保留在不另行通知的情况下修改本文档的权利，并保留对本文档内容的全部解释权。
“263网络通信”标识是263网络通信股份有限公司的注册商标。
ThisdocumentcontainsconfidentialtechnicalandcommercialinformationfromNet263Ltd,andisintendedfortheuseofCustomersorNet263’spartnersonlyforthepurposesofrelatedprojectstoNet263.NopartofitmaybereproducedortransmittedinanyformormeanswithoutthewrittenpermissionofNet263.
Thisdocumentandtheproductitdescribesareprotectedbycopyrightaccordingtotheapplicablelaws.
Theinformationinthisdocumentissubjecttochangewithoutnoticeanddescribesonlytheproductdefinedintheintroductionofthisdocumentation.Net263will,ifnecessary,explainissues,whichmaynotbecoveredbythedocument.
“Net263”logoisaregisteredtrademarkofNet263Ltd.
修订历史
日期
版本
说明
作者
2009-6-17
1.0
创建文档
张盛广
目录
1.概述1
1.1范围1
2.定义1
2.1术语1
3.接口概述1
4.流程设计2
5.接口设计2
5.1接口描述2
5.2接口定义3
1.概述
综合通信系统是以电子邮件为基础，263EM（即时消息）为核心，集成第三方应用软件的综合通信平台。
系统根据业务需要可以无限集成第三方应用软件，前提是第三方应用软件支持本规范（《263EM企业应用用户管理接口规范》）。
范围
本文描述了263EM企业应用用户管理接口规范。
2.定义
术语
术语
定义
MA
ManagerAgent，管理代理，企业邮件系统管理员、企业管理员管理企业用户数据的工具
WS
Webserviceinterface,263提供的soap协议读取用户列表接口
3.接口概述
企业使用263EM，可以通过263提供的管理软件以及开发接口将本企业需要的企业应用软件加载到263EM客户端，供本企业用户方便的使用。
自建的企业应用分两种类型：
●拥有独立用户帐号的企业应用软件
这种类型的企业应用软件，自己有独立的帐号系统，有独立的登录页面。
同时也可以通过登录263EM客户端跳转登录。
●没有独立用户帐号的企业应用软件
这种类型的企业应用软件，用户帐号全部通过263邮件系统获取，自己没有登录界面，只能通过登录263EM后跳转登录。
这种类型的企业应用软件，从263邮件系统获取用户帐号以后，仍然需要存储在本地数据库。
此类企业应用软件需要定时从263邮件系统获取最新的用户帐号，以维护本地数据的即时性和有效性。
本文档所述是针对后一种企业应用软件，即没有独立用户帐号的企业应用软件，如何使用WS接口从263邮件系统中获取所需的用户帐号列表的接口规范。
4.流程设计
图：
用户管理接口使用流程
1）用户在MA系统中点击EM企业应用，选择设置接口访问权限栏，设置接口访问需要使用的帐户名/密码。
记住帐户密码。
2）企业自建应用服务根据263提供的webservice接口开发相应的读取列表功能；连接263提供的WS服务端口，传递域名、帐户名、密码，读取本域用户列表。
3）WS服务接收来自企业自建应用的请求协议，根据用户在MA中自行设置的账户密码，验证用户访问权限的合法性。
4）WS将请求处理结果返回给用户，正确返回用户列表；错误返回相应错误码；
5.接口设计
接口描述
企业域管理员通过MA管理界面设定，自建企业应用访问本域开通了263EM的用户列表的访问权限；接口使用webservice通信协议进行通信。
根据填写的用户名和密码进行验证，验证通过后，返回域下开通EM功能的用户列表。
接口定义
接口名称
key
XML流
获取域信息
GetSaasDomainUserlist
请求信息：
GetSaasDomainUserlist获取域信息
参数说明：
domain:
该应用所属域名，由调用者填写；
userid:
用户名，由调用者填写，验证用；
passwd:
密码，由调用者填写，验证用；
返回结果：
返回为xml格式的字符串。
分为部门和用户两部分数据，格式如下：
//所有部门数据
//所有用户数据
以下为返回结果的示例：
正确返回：
xmlversion="1.0"encoding="UTF-8"?
>
……
……
错误返回：
-401访问账户错误
-267密码验证错误
-5系统错误
Xmapi.Wsdl文件格式描述：
xml version="1.0" encoding="UTF-8"?
>
targetNamespace="http:
//192.168.18.233:
10080/exmws/xmapi.wsdl"
xmlns:
tns="http:
//192.168.18.233:
10080/exmws/xmapi.wsdl"
xmlns:
SOAP-ENV="http:
//schemas.xmlsoap.org/soap/envelope/"
xmlns:
SOAP-ENC="http:
//schemas.xmlsoap.org/soap/encoding/"
xmlns:
xsi="http:
//www.w3.org/2001/XMLSchema-instance"
xmlns:
xsd="http:
//www.w3.org/2001/XMLSchema"
xmlns:
ns="urn:
xmapi"
xmlns:
SOAP="http:
//schemas.xmlsoap.org/wsdl/soap/"
xmlns:
MIME="http:
//schemas.xmlsoap.org/wsdl/mime/"
xmlns:
DIME="http:
//schemas.xmlsoap.org/ws/2002/04/dime/wsdl/"
xmlns:
WSDL="http:
//schemas.xmlsoap.org/wsdl/"
xmlns="http:
//schemas.xmlsoap.org/wsdl/">
xmapi"
xmlns:
SOAP-ENV="http:
//schemas.xmlsoap.org/soap/envelope/"
xmlns:
SOAP-ENC="http:
//schemas.xmlsoap.org/soap/encoding/"
xmlns:
xsi="http:
//www.w3.org/2001/XMLSchema-instance"
xmlns:
xsd="http:
//www.w3.org/2001/XMLSchema"
xmlns:
ns="urn:
xmapi"
xmlns="http:
//www.w3.org/2001/XMLSchema"
elementFormDefault="unqualified"
attributeFormDefault="unqualified">
//schemas.xmlsoap.org/soap/encoding/"/>
--operationrequestelement-->
string"/>
--operationrequestelement-->
string"/>
--operationrequestelement-->
string"/>
--operationresponseelement-->
int"/>
--operationresponseelement-->
string"/>
Ok-Flag"/>
xml-buf"/>
domain"/>
userid"/>
passwd"/>
Servicedefinitionoffunctionns__GetSaasDomainUserlist
GetSaasDomainUserlistRequest"/>
Rtn-Domain-User-List"/>
xmapiPortType">
binding style="rpc" transport="http:
//schemas.xmlsoap.org/soap/http"/>
operation soapAction=""/>
body use="literal" namespace="urn:
xmapi"/>
body use="literal" namespace="urn:
xmapi"/>
gSOAP2.7.0dgeneratedservicedefinition
xmapi">
address location="http:
//192.168.18.233:
10080/exmws//xmapi.cgi"/>
升级会员 