三方系统提供写入OpenAPI

三方异构系统提供写入OpenAPI,由COP定时调用接口主动推送,完成组织同步模式。

1、概述

COP负责新建、编辑、启停等组织数据维护,三方异构系统提供写入OpenAPI,由COP定时调用接口主动推送,完成组织同步模式。

2、优缺点

a. 优点

i. 三方系统集成压力小;

ii. 通过事件订阅触发数据同步,数据时效性高;

b. 缺点

i. 实施团队需要了解三方系统接口字段要求和数据用途;

ii. 实施团队需要了解COP平台字段要求和用途;

iii. 实施团队需要配置字段映射;

iv. 每增加一个三方系统,就需要重新配置一遍一下步骤;

3、操作步骤

序号 步骤名称 责任方 使用场景
1 提供组织增量写入接口规范和文档 三方系统 必须,
2 注册并配置鉴权AppID和秘钥 三方系统 非必须,如果三方系统接口调用时涉及到安全鉴权,则需要提供
3 提供接口调用示例 三方系统 必须,为了集成效率,
强烈建议三方系统提供可直接使用的postman接口调用示例,
4 新建三方集成应用 致远 必须,三方集成应用负责封装三方系统接口和配置数据映射
5 发布启用三方集成应用 致远 必须,三方集成应用只有发布后才能正常使用
6 封装安全认证 致远 非必须,如果三方系统接口调用时涉及到安全鉴权,则需要配置安全认证
7 接口封装 致远 必须,三方系统提供的接口只有正常封装后才能供给COP使用
8 在线调试验证 致远 必须,三方系统接口封装完成后,需要在线调试,验证网络通信、
接口返回结果是否正确等
9 启用组织同步 致远 必须,主动推送场景中,字段映射、同步周期需要在基础集成中配置
10 配置同步内容 致远 必须,本场景下固定选择模式为:从三方系统获取
11 配置同步周期 致远 必须,根据数据量和服务器消费能力,合理配置同步周期
12 配置字段映射 致远 必须:三方系统接口文档中的字段名,字段释义与COP不一致,
需要配置参数映射、层级转换等
13 使用日志 致远 必须,配置完成并启用后,查看使用日志

4、 集成配置步骤

4.1、 新建三方集成应用

1720577772586

4.2、 发布启用三方集成应用

1720577778838

4.3、 封装安全认证

1720577785293

1720577791255

4.4、 枚举定义

1720577798040

4.5、 接口封装

1720577803045

1720577809284

1720577814794

1720577821105

1720577827141

1720577832287

1720577837929

4.6、 在线调试验证

1720577846536

1720577853174

4.7、 启用组织同步

1720577859417

4.8、 配置同步内容

1720577865174

1720577874631

1720577880163

4.9、 配置同步周期

1720577889066

4.10、 使用日志

1720577894429

5、 注意事项

5.1、 当三方系统需要的数据维度较COP更加丰富时,可以通过集成扩展-微流程编排实现;

最后修改 September 4, 2024: 其他路径全部更新英文 (b95746c)