集成连接平台

• 1: 基础设置
• 1.1: 组织映射
• 1.2: 应用参数
• 1.3: 参数转义
• 1.4: 数据源配置
• 2: 集成应用（连接器）
• 2.1: 应用管理
• 2.2: 接口登记
• 2.3: 读写数据库
• 2.4: 事件订阅
• 2.5: 消息队列
• 2.6: 应用菜单
• 2.7: 单点登录
• 2.8: 组织同步
• 2.9: 事项同步
• 2.10: 消息同步
• 2.11: 监控日志
• 3: 开放平台
• 3.1: API手册
• 3.2: API管理
• 3.3: 事件管理
• 3.4: 接入应用
• 4: 基础能力接入
• 4.1: 短信
• 5: 移动插件
• 5.1: 插件管理
• 5.2: 企业信息维护
• 5.3: 组织同步
• 5.4: 免登
• 5.5: 应用上架
• 5.6: 消息同步
• 5.7: 事项同步
• 5.8: 运行配置
• 5.9: 监控日志

1、概述

集成连接平台是一种创新的云架构和集成连接服务，专为帮助企业实现多种应用系统和数据的无缝集成而设计。该平台基于新一代微服务和容器技术，通过无代码配置方式，将企业内部和外部的不同系统和业务流程统一连接到同一个集成平台上。使企业能够迅速实现跨系统的业务融合和数据互通，满足企业在统一组织用户管理、统一待办事项、统一消息通知、统一登录认证、统一移动办公等全场景业务融合的信息化建设需求。通过集成连接平台，企业可以大幅提升业务效率和信息化水平，实现更加智能和高效的运营。

2、平台定位

企业级一站式集成平台

开放平台：提供API管理、事件管理和接入应用管理能力；

三方能力接入：为平台应用提供开箱即用的三方能力接入；

应用连接器：提供三方应用管理、服务集成、消息集成、数据集成和单点登录集成能力；

基础集成：提供可视化组织集成、事项集成、消息集成配置能力；

3、本章节目标用户

本章节主要面向需要系统的学习集成平台的用户，逐个讲解集成平台底层能力特征。

4、集成架构图

5、微服务版本要求

微服务	微服务名称	版本号	更新时间
cip-capability	基础能力接入	≥3.5.0	2024年7月30日
cip-connector	连接器	≥3.5.0	2024年7月30日
cip-convert	集成转换	≥3.5.0	2024年7月30日
cip-manager	集成管理	≥3.5.0	2024年7月30日
ctp-user	用户中心	≥3.5.0	2024年7月30日

6、能力特征清单

1 - 基础设置

1、概述

提供租户级、跨应用共享的基础数据设置。

2、角色权限定义

3、能力特征清单

1.1 - 组织映射

1、概述

提供公共的、跨应用共享的平台内外组织、人员映射管理，解决COP与三方应用间组织、人员标识字段不一致，但需要实现组织、人员信息交换的场景。

2、能力位置

能力路径：管理后台–>集成平台–>基础设置–>组织映射

URL相对路径：/main/backstageManage/cip-connector/mapping-config/app

3、能力特征

3.1、特征清单

3.2、核心界面示例

4、使用场景

4.1、单点登录

当COP与三方系统间需要单点登录，且用户标识字段不统一时，使用用户映射建立用户一对一的绑定关系，登录终端包含PC端单点登录和移动端单点登录；

4.2、事项同步

当三方系统提供事项写入接口，COP负责将事项数据同步到三方系统时，可以根据用户映射，将COP用户转为三方系统可识别的用户标识。

4.3、消息同步

当三方系统提供消息接收接口，COP负责将消息数据同步到三方系统时，可以根据用户映射，将COP用户转为三方系统可识别的用户标识。

4.4、移动插件免登用户映射

移动插件新建时，自动生成用户映射和部门映射配置，数据自动写入；

4.5、组织同步自动写入用户映射数据

组织同步时，通过开启用户映射配置，用户映射数据会自动写入当前【集成应用-免登】关联的用户映射中；

4.6、用户自助更新三方用户标识

用户在前台-个人设置中，维护具体三方异构系统与COP平台用户关系，只能维护当前登录账号的用户映射。

1.2 - 应用参数

1、概述

提供一套公共的、跨应用共享的参数配置，包含参数启停、引用跟踪、请求地址校验等功能。

2、能力位置

能力路径：管理后台–>集成平台–>基础设置–>应用参数

URL相对路径：/main/backstageManage/cip-connector/app-register/app

3、能力特征

3.1、特征清单

3.2、核心界面示例

4、使用场景

4.1、跨应用参数共享：

当目标系统为大型ERP系统，一个系统包含多个应用时,由于各应用体量大而拆分成多个集成应用时，就需要一套在应用间共享的应用参数，减少用户实施压力。

4.2、跨环境参数统一维护：

当跨环境导出、导入应用时，用户无需逐个进入应用，即可维护请求地址、三方应用ID、三方应用秘钥等共享参数。

4.3、应用关系在线跟踪：

当用户需要根据应用核心参数梳理应用间关系时，可以参考引用记录直接确定三方应用关系。

1.3 - 参数转义

1、概述

提供COP平台内部实体编码或枚举与第三方系统实体编码或枚举的转换机制。主要用于COP平台与第三方系统相互调用时的实体编码或枚举转换。

2、能力位置

能力路径：管理后台–>集成平台–>基础设置–>参数转义

URL相对路径：/main/backstageManage/cip-manager/escape-setting/app

3、能力特征

3.1、特征清单

3.2、核心界面示例

4、使用场景

4.1、外部编码自动转义为内部实体编码

UDC定制应用通过三方集成应用调用三方接口时，且参数类型为实体/枚举时，可以将入参由内部ID转义为外部编码或者内部ID转义为内部编码，出参由外部编码转义为内部编码或者外部编码转义为内部ID；

配置规则如下：

参数转义：厂商标识==集成应用：厂商标识

参数转义：产品标识==集成应用：标识

参数转义：版本号==集成应用：版本号

参数转义：应用==集成应用-接口-参数：转义应用（对应后台代码需要添加注解）

参数转义：实体/枚举==集成应用-接口-参数：转义实体（对应后台代码需要添加注解）

4.2、OpenAPI自动将外部编码转义为内部实体ID

三方系统调用开放平台OpenAPI时，可以将请求参数外部编码自动转义为内容实体ID，返回参数由内部实体/枚举ID转为外部编码；

配置规则如下：

参数转义：厂商标识==接入应用：厂商标识

参数转义：产品标识==接入应用：产品标识

参数转义：版本号==接入应用：版本号

参数转义：应用==接入应用-参数：转义应用（对应后台代码需要添加注解）

参数转义：实体/枚举==接入应用-参数：转义实体（对应后台代码需要添加注解）

1.4 - 数据源配置

1、概述

提供公共的、跨应用的、可视化的数据源配置配置，将数据库配置、MQ连接信息抽象到数据源配置。并提供在线测试连接功能，以便多个连接器可以公用一个数据源，同时在跨环境推送时，可以直接修改数据源，而不需要进入到各个连接器中逐一修改数据源。

2、能力位置

能力路径：管理后台–>集成平台–>基础设置–>数据源配置

URL相对路径：/main/backstageManage/cip-connector/database-config/app

3、能力特征

3.1、数据源配置

3.2、数据库类型、版本支持

3.3、消息队列类型、版本支持

3.4、核心界面示例

4、使用场景

4.1、读写数据库

配合集成应用，提供异构数据库读写能力；

4.2、消费消息

配合集成应用，提供Kafka、Rocket消息订阅和消费能力；适用于组织同步、事项同步、消息同步

4.3、投递消息

配合集成应用，提供Kafka、Rocket消息投递能力；

2 - 集成应用（连接器）

1、概述

封装三方异构系统服务，使其符合COP自建应用规范，COP平台内应用可以直接调用三方应用。

2、能力位置

能力路径：管理后台–>集成平台–>三方应用集成–>集成应用管理

URL相对路径：/main/backstageManage/cip-connector/connector/app

3、能力导图

4、角色权限定义

5、能力特征清单

2.1 - 应用管理

1、概述

提供应用新建、复制、导出、导入、删除、发布等应用管理能力。

2、能力特征

2.1、特征清单

2.2、核心界面示例

2.2.1、导出（原样导入、复制导入）

2.2.2、应用管理（新建、设计、发布、复制、导出、删除）

2.2.3、异构接口登记后，开放至开放平台

3、使用场景

3.1、跨环境导出导入

集成应用导出后，在新建页面支持原样导入和复制导入两种导入模式

原样导入：AppId不变、标识不变、名称不变、低代码定制应用依赖关系不变，BPM表单应用依赖关系不变；

复制导入：AppId重新生成、标识可修改、名称不变可修改、低代码定制应用依赖关系丢失，BPM表单应用依赖丢失；

3.2、复制备份

复制时，原集成应用不变，会重新生成一个新的集成应用，效果类似复制导入。用于备份配置、三方异构系统差异小时使用；

3.3、API登记后发布至COP开放平台

三方异构系统接口注册封装到集成应用后，开启能力开放，则会把三方异构系统接口发布至开放平台，遵循平台统一的权限管理、请求域名、安全签名，做到轻量级ESB总线能力。

2.2 - 接口登记

1、概述

封装三方系统接口，使其符合COP平台规范，平台内应用可以直接使用【自定义服务】形式调用。

2、能力特征

2.1、特征清单

2.2、核心界面示例

2.2.1、接口登记

2.2.2、分页配置

2.2.3、安全认证、接口签名鉴权

2.2.4、公共参数和返回码

3、使用场景

2.3 - 读写数据库

1、概述

直连三方系统数据库库，实现数据库表数据查询、写入、更新、删除等操作，使平台内应用可以直接通过【自定义服务】操作三方数据库。

2、能力特征

2.1、特征清单

2.2、核心界面示例

2.2.1、选择数据源、接口登记转为数据库直连配置

2.2.2、数据直连配置

3、使用场景

2.4 - 事件订阅

1、概述

监听三方系统事件，并写入到COP平台内部事件中，COP应用可以通过事件监听直接获取三方系统事件内容。

2、能力特征

2.1、特征清单

2.2、核心界面示例

2.2.1、事件定义

3、使用场景

3.1.1、三方系统投递事件

3.1.2、低代码应用监听事件

2.5 - 消息队列

1、概述

支持三方消息队列数据投入和数据消费能力。

2、能力特征

2.1、特征清单

2.2、核心界面示例

3、使用场景

3.1、低代码应用投递消息

3.2、低代码应用消费消息

2.6 - 应用菜单

1、概述

支持三方系统菜单、功能页面封装能力。配合单点登录能力，可以在授权后免登进入三方系统。

2、能力特征

2.1、特征清单

2.2、核心界面示例

2.2.1、新建/编辑菜单

2.2.2、角标

3、使用场景

3.1、发布应用时，菜单自动发布至应用中心

2.7 - 单点登录

1、概述

实现COP平台单点登录跳转到三方系统。

2、能力特征

2.1、特征清单

2.2、核心界面示例

2.2.1、配置单点登录

2.2.2、选择并配置用户映射

3、使用场景

3.1、单点登录效果查看

3.2、COP单点登录三方异构系统(菜单、事项详情页、消息详情页)

2.8 - 组织同步

1、概述

支持COP平台与三方系统间的组织、人员数据同步能力。

2、能力特征

2.1、特征清单

2.1.1、同步配置

2.1.2、同步补偿

2.2、核心界面示例

2.2.1、参数配置

2.2.2、同步内容配置

2.2.3、自定义同步维度

2.2.4、数据过滤和绑定扩展字段

2.2.5、字段映射配置

2.2.6、运行配置

3、使用场景

2.9 - 事项同步

1、概述

支持COP平台与三方系统间的事项同步能力。

2、能力特征

2.1、特征清单

2.1.1、同步配置

2.1.2、同步补偿

2.2、核心界面示例

2.2.1、选择同步模式

2.2.2、配置信息（选择接口、执行频率、是否同步生成消息）

2.2.3、字段映射

3、使用场景

2.10 - 消息同步

1、概述

支持COP平台与三方系统间的消息数据同步能力。

2、能力特征

2.1、特征清单

2.2、核心界面示例

2.2.1、选择同步模式

2.2.2、配置信息（选择接口、执行频率）

2.2.3、字段映射

3、使用场景

2.11 - 监控日志

1、概述

支持应用内使用日志可视化展示能力。

2、能力特征

2.1、特征清单

2.2、核心界面示例

2.2.1、接口调用日志

2.2.2、事件监听日志

2.2.3、消息队列日志

2.2.4、单点登录日志

2.2.5、组织同步日志

2.2.6、事项同步日志

2.2.7、消息同步日志

2.2.8、同步补偿日志

3、注意事项

3.1、由于日志采用异步计入，所以会有延迟展示，最多延迟5分钟；

3 - 开放平台

1、概述

提供完备的OpenAPI数据开放能力和授权管理能力。

2、能力导图

3、角色权限定义

4、能力特征清单

3.1 - API手册

1、概述

展示COP平台所有OpenAPI和应用错误码信息。

2、能力特征

3、使用场景

3.1、场景化接口清单

提供基于场景的API清单，便于特定场景的API查看。

4、平台错误码

3.2 - API管理

1、概述

提供全量API刷新、API启用/停用、接口内容查看、全量接口文档导出能力。

2、能力特征

3、使用场景

3.1、API启用/停用

属于API一级授权，只有启用的接口，在配置接入应用时才可以查看并进行二次授权。

3.2、接口文档导出

接入应用中的接口文档导出，可以导出对应应用已授权的接口文档，API管理中的导出，可以导出所有启用的接口文档。

3.3、API刷新

API主要来源于原生应用（组织模型、事项中心）、自建应用（UDC定制应用）、三方API（三方集成应用），针对后两个API来源，需要应用发布并启用后，在API管理页刷新API才可以查看对应API。

3.3 - 事件管理

1、概述

提供全平台事件查看、启用/停用、事件内容查看能力。

2、能力特征

3、使用场景

3.1、事件启停

事件一级授权，只有启用的事件，才可以在接入应用中选择并进行二次授权使用。

3.4 - 接入应用

1、概述

为每一个需要访问COP平台OpenAPI和事件的三方应用系统，分配独立的授权信息，并监控调用日志。

2、能力特征

2.1、接入应用管理

2.2、OpenAPI授权

2.3、事件订阅授权

2.4、安全设置

2.5、使用日志

2.6、nacos高级设置

3、使用场景

3.1、接口授权

集成平台提供两层接口授权机制，第一级授权叫做API启用，启用后所有接入的应用才可以查看响应接口，并进行二次授权，一级授权目的是限制接口使用范围和场景，提高系统可用性和稳定性。

当API启用后，管理员可以针对每个接入应用，添加二级授权，被授权应用只可以访问当前应用已经授权的接口。

3.2、接口文档

添加二级授权后，被授权应用可以自动导出已授权接口的接口文档。接口文档以Word形式导出，且系统采用异步导出接口文档形式，降低内存消耗。

3.3、事件订阅

平台提供的事件同样遵循二级授权管理模式，由COP定义事件消息体，三方系统提供事件接收URL，COP平台触发事件后，三方系统就可以实时接收到对应的事件提醒和事件内容。

3.4、IP白名单

平台提供访问白名单机制，如果未配置白名单，则所有网络联通，且拥有平台颁发的AppKey和APPSecret的调用方都可以正常调用对应授权接口。开启白名单后，只有出口IP一致的调用方才可以正常调用已授权接口。

平台提供签名启用/停用配置，启用后，调用接口需要APPKey和AppSecret；停用时，调用方只需要提供AppKey即可，不需要提供APPSecret和签名sign。停用签名场景主要针对客户有企业级开放平台时或者防火墙策略完善场景。

3.5、请求限流

平台提供访问限流控制，管理员可以配置不限流，或者配置周期内访问次数限制，主要针对服务器资源紧张、内存压力大场景。

3.6、接口调用demo

场景：比如外部需要调用接入应用中开放的组织机构人员信息查询接口，该接口业务参数是人员id。
由于demo中使用了技术平台JsonUtils、MD5、HttpClientUtil等工具类，所以需要您在您工程中依赖boot-core

<dependency>
    <groupId>com.seeyon</groupId>
    <artifactId>boot-core</artifactId>
    <version>3.9.0</version>
</dependency>

java代码如下：

import com.seeyon.boot.util.JsonUtils;
import com.seeyon.boot.util.MD5;
import com.seeyon.boot.util.http.HttpClientUtil;
import com.seeyon.boot.util.http.common.HttpHeader;

import java.util.HashMap;
import java.util.Map;

/**
 * Description:
 * Author: weijh
 * Date: 2024/11/5 15:30
 */
public class OpenApiTest {
    public static void main(String[] args) {
        String appKey = "您的appKey";
        String appSecret = "您的appSecret";
        Map<String, Object> param = new HashMap<>();
        Long reqId = System.currentTimeMillis();
        param.put("requestId", reqId);
        param.put("timestamp", reqId);
        param.put("data", "人员id");


        HttpHeader httpHeader = HttpHeader.custom();
        httpHeader.add("app-key", appKey);
        httpHeader.add("sign-type", "MD5");
        String jsonStr = JsonUtils.toJson(param);
        String sign = MD5.getMD5String(appSecret + jsonStr + appSecret);
        httpHeader.add("sign", sign);
        String result = HttpClientUtil.post("https://openapi-pre.seeyonv8.com/organization/base/member/selectById", jsonStr, httpHeader);
    }
}

3.7、postman调用demo

openapi-demo调用.postman_collection.json

4 - 基础能力接入

1、概述

封装三方异构系统服务，使其符合COP自建应用规范，低代码定制应用可以直接调用三方应用。集成能力包含接口调用、单点登录、菜单挂载、事件订阅、消息队列、组织同步、待办事项同步、消息同步等能力。

2、角色权限定义

3、能力清单

4.1 - 短信

1、概述

提供单条、批量发送短信能力，支持配置短信签名、短信模板，满足短信消息、短信登录验证、下发验证码等使用场景。

2、预制厂商通道

3、能力区隔

4、接口清单

4.1、对内接口

适用场景：低代码应用通过【自定义服务】节点调用时

4.1.1、异步批量多条内容发送短信

请求参数

请求示例

{
            "paramsMap": "",
            "code": "5892855977121107819",
            "appName": "cip-capability",
            "debugging": "false",
            "language": "",
            "desPhone": "15652161982,15011561982"
        }

返回参数

返回示例

{
    "code": "200",
    "message": "成功"
}

4.1.2、同步方式发送短信

请求参数

请求示例

{
        "paramsMap": "",
        "code": "",
        "appId": "cip-capability",
        "desPhone": "15652161982,15011561982"
    }

返回参数

返回示例

{
    "code": "200",
    "message": "成功"
}

4.1.3、异步方式发送短信

请求参数

请求示例

{
        "paramsMap": "",
        "code": "",
        "appId": "cip-capability",
        "desPhone": "15652161982,15011561982"
    }

返回参数

返回示例

{
    "code": "200",
    "message": "成功"
}

4.2、对外接口

适用场景：三方异构系统通过开放平台调用时

4.2.1、异步批量多条内容发送短信

请求地址：/cip-capability/ShortMessageAppServiceImpl/sendShortMessageAsync

请求参数

请求示例

{
    "data": [
        {
            "paramsMap": "",
            "code": "5892855977121107819",
            "appName": "cip-capability",
            "debugging": "false",
            "language": "",
            "desPhone": "15652161982,15011561982"
        }
    ],
    "requestId": "-8361350560943291150",
    "notifyUrl": "",
    "timestamp": 1719476506062
} 

返回参数

返回示例

{
    "code": "200",
    "data": {
        "content": ""
    },
    "message": "成功",
    "status": "FRONT"
}

4.2.2、同步方式发送短信

请求地址：/cip-capability/ShortMessageAppServiceImpl/sendSycShortMessage

请求参数

请求示例

{
    "data": {
        "paramsMap": "",
        "code": "",
        "appId": "cip-capability",
        "desPhone": "15652161982,15011561982"
    },
    "requestId": "1850710295428812002",
    "notifyUrl": "",
    "timestamp": 1719476506066
}

返回参数

返回示例

{
    "code": "200",
    "data": {
        "content": {
            "code": "capability-0000",
            "message": "模板不合法"
        }
    },
    "message": "成功",
    "status": "FRONT"
}

4.2.3、异步方式发送短信

请求地址：/cip-capability/ShortMessageAppServiceImpl/sendShortMessage

请求参数

请求示例

{
    "data": {
        "paramsMap": "",
        "code": "",
        "appId": "cip-capability",
        "desPhone": "15652161982,15011561982"
    },
    "requestId": "1938010543906177955",
    "notifyUrl": "",
    "timestamp": 1719476506070
}

返回参数

返回示例

{
    "code": "200",
    "data": {
        "content": ""
    },
    "message": "成功",
    "status": "FRONT"
}

5、使用场景

5.1、登录场景-短信验证码

5.2、短信消息

5.3、BPM短信提醒

5.4、开放OpenAPI

5 - 移动插件

1、概述

COP平台适配主流移动办公终端产品、公众端产品，包含飞书、企业微信、钉钉、微信公众号、微信小程序等。能够实现与以上第三方产品无缝集成，将COP平台及其集成的第三方业务系统产生的消息、事项推送至各个办公终端产品、公众端产品的“微协同”中，帮助企业打造完整的移动协同办公生态，打造企业快捷、高效、安全、统一的移动工作入口。

2、角色权限定义

3、能力清单

5.1 - 插件管理

1、概述

提供应用新建、复制、导出、导入、删除、发布等应用管理能力。

2、能力特征

2.1、特征清单

2.2、核心界面示例

2.2.1、新建移动插件

3、注意事项

新建移动插件时，会自动生成部门映射和用户映射，用户可以在移动插件中维护，也可以在基础设置-组织映射中维护，用户映射名称为：”用户映射默认_“+移动插件企业编码

5.2 - 企业信息维护

1、概述

维护移动APP企业信息、企业级凭证信息。

2、能力特征

2.1、特征清单

2.2、核心界面示例

2.2.1、注册企业信息

5.3 - 组织同步

1、概述

实现COP平台与移动APP通讯录之间的组织、用户数据同步。

2、能力特征

2.1、特征清单

2.2、核心界面示例

2.2.1、组织同步

5.4 - 免登

1、概述

实现移动APP免登打开COP平台应用首页、事项详情页、消息详情页。

2、能力特征

2.1、特征清单

2.2、核心界面示例

2.2.1、用户映射

3、注意事项

3.1、COP与移动APP手机号码一致时，用户可以免登录从APP进入COP页面，此时，无需手工配置用户映射

5.5 - 应用上架

1、概述

将COP应用首页、个人空间、特定功能页上架到移动APP个人工作台。

2、能力特征

2.1、特征清单

2.2、核心界面示例

2.2.1、应用发布、上架

3、注意事项

3.1、由于移动APP限制，用户手工复制应用发布详情页的移动端免登地址，粘贴到移动APP管理工作台中。

5.6 - 消息同步

1、概述

将COP平台消息实时推送给移动APP。

2、能力特征

2.1、特征清单

2.2、核心界面示例

由于移动APP差异，造成移动APP消息展示效果不同，请参考平台实施-移动微协同目录下具体APP终端效果图。

5.7 - 事项同步

1、概述

COP平台采用H5页面挂载形式，将事项中心页面挂载到移动APP上。

2、能力特征

2.1、特征清单

2.2、核心界面示例

5.8 - 运行配置

1、概述

配置移动APP接口固定时间段内API访问上限，并验证API连通性。

2、能力特征

2.1、特征清单

2.2、核心界面示例

2.2.1、熔断保护

5.9 - 监控日志

1、概述

支持移动插件使用日志可视化展示能力。

2、能力特征

2.1、特征清单

2.2、核心界面示例

2.2.1、使用日志