网易企业邮箱集成接口技术白皮书v111HZ.docVIP

网易企业邮箱 集成接口技术白皮书 稳定可靠，安全无忧 V1.1.HZ 修订历史记录 版本 日期 修订说明 编制 审核 0.1 2012-4-28 文档第一版，完成部门帐号同步接口、单点登录接口、未读邮件数量接口和添加自定义登录框 湛舜研 0.2 2012-5-9 完成文档概述和接口综述，修改各接口介绍中的文字错误 徐亭 湛舜研 1.0 2012-5-14 修改2.6申请流程，修改6.2 接口规范，强调域名一致与域名值为客服提供的代码串 徐亭 湛舜研 1.1 修改1.3术语解析：RSA算法，增加URL 湛舜研 目 录 1 关于文档 1 1.1 目标 1 1.2 读者 1 1.3 术语定义 1 1.4 如何获得帮助 1 2 接口综述 2 2.1 目标 2 2.2 功能概述 2 2.3 总体架构 2 2.4 前提条件 3 2.5 应用步骤 3 2.6 申请流程 4 3 部门帐号同步接口 5 3.1 接口说明 5 3.2 接口规范 5 3.2.1 技术规范 5 3.2.2 使用规范 5 3.3 加密参数说明（enc值） 6 3.3.1 操作说明（action值） 6 3.3.2 操作参数说明 8 3.3.3 URL示例 9 3.3.4 操作示例 10 3.4 应用示例 11 4 单点登录接口 12 4.1 接口说明 12 4.2 接口规范 12 4.2.1 技术规范 12 4.2.2 使用规范 12 4.3 应用示例 13 5 未读邮件数量接口 14 5.1 接口说明 14 5.2 接口规范 14 5.2.1 技术规范 14 5.2.2 使用规范 14 5.3 应用示例 15 6 自定义登录框接口 16 6.1 接口说明 16 6.2 接口规范 16 6.2.1 技术规范 16 6.2.2 数据规范 16 6.2.3 注意事项 17 6.3 应用示例 17 关于文档 目标 这份文档帮助客户或经销商详细了解网易企业邮箱接口集成的具体功能和操作方法。 读者 这份文档的预期读者为客户IT相关负责人、经销商客服和技术支持人员。 术语解析 HTTP协议 超文本传输协议(HTTP)是一种通信协议，它允许将超文本标记语言(HTML)文档从web服务器传送到Web浏览器。 URL 统一资源定位符（URL，英语UniformResourceLocator的缩写）也被称为网页地址，是因特网上标准的资源的地址。统一资源定位符 URL 是对可以从因特网上得到的资源的位置和访问方法的一种简洁的表示。 RSA加密算法 RSA加密算法是是目前最有影响力的公开密钥密码体制加密算法，它能够抵抗到目前为止已知的所有密码攻击，已被ISO推荐为公钥数据加密标准接口综述 目标 网易企业邮箱拥有多个集成接口供客户使用，并能与其他业务系统进行集成。 功能概述 网易企业邮箱提供多种集成接口与客户应用系统进行无缝集成，可实现与用户应用系统中组织架构同步和未读邮件数同步，并且可以在用户应用系统或者用户网站登录首页实现单点登录或者嵌入自定义登录的入口，解决了网易企业邮箱系统与客户应用系统的集成数据共享问题。采用公私钥加密技术和服务请求IP地址过滤等方案保障数据交互接口的安全。 总体架构 前提条件 接口类型 前提条件 部门账号同步 系统的可扩展性、有固定的登录IP 单点登录 系统的可扩展性 未读邮件数 系统的可扩展性、有固定的登录IP 自定义登录 从企业域名对应的网站或系统登录 应用步骤 引用RSA工具包：RSA-1.1.1.jar 生成密钥：ease.domainmail.Utils.createKeyPair(); 执行结果如下： 把公钥和IP地址告诉接口提供方进行授权。 (注：单点登录接口不需要限定IP，可以不提供) 生成操作参数（原始字符串）。 参数加密：ease.domainmail.Utils.encrypt(String priKey, String source);其中，priKey是私钥，source是原始字符串，返回加密后的字符串。 组装完整URL请求地址。 发送POST请求。 返回操作结果。 申请流程 注：上述流程图中红色字体部分的是客户申请需提供的资料 部门帐号同步接口 接口说明 部门帐号同步接口通过HTTP协议访问接口并提交同步指令，支持创建、更新和删除部门或子部门，创建、禁用、删除和恢复用户，修改帐号密码和属性。 接口规范 技术规范 客户按网易企业邮箱提供的算法（标准RSA算法，1024位密钥长度）生成公私钥，将公钥提供给网易企业邮箱，私钥自行妥善保管，通过接口提交URL链接参数必须使用RSA私钥加密，禁止明文传输。国内银行的网银通讯也是采用此类加密传输方式，可以有效防止数据被盗用或篡改，给予用户数据安全保护的最高