外部系统API集成路线选择

栏目:云苍穹知识作者:金蝶来源:金蝶云社区发布:2024-09-23浏览:1

外部系统API集成路线选择

1 业务场景

当用户需要将外部系统的WebAPI登记到苍穹中进行调用时,集成服务云提供了WebAPI登记自定义API外部系统API登记三种功能。

注:不推荐使用外部系统API登记,推荐使用WebAPI登记功能进行登记。


2 解决方案

对于新三方系统的API登记,推荐使用WebAPI登记功能。对于已有连接类型的三方系统API登记,先在连接类型中搜索系统名称。如果找到预置连接类型并包含调用脚本,建议使用外部系统API登记。对于需要引用其他集成资源或有复杂调用逻辑的系统,则可以使用自定义API


场景细分选择说明:

场景一:预置连接类型有维护API调用脚本且有预置部分外部系统API则可复用 ,使用外部系统API登记(但不推荐) ,基于连接类型API调用脚本的WebAPI登记,抽象出共通的API调用脚本,只需要补充API调用路径、入参和出参即可完成登记。

场景二:没有预置连接类型且不需要调用其他资源,推荐使用WebAPI登记,符合开发习惯的WebAPI登记,无需编写请求脚本,维护调用参数(url,请求头,请求体等),即可后台完成组装调用。

场景三:没有预置连接类型但需要调用其他资源,使用自定义API,敏捷灵活的WebAPI登记,可以使用脚本调用各种集成资源(自定义函数、集成方案、服务流程等),并发起请求。



  • 外部系统API:走的统一的连接类型的调用脚本逻辑,需要完成必要的url,query参数,请求头,请求体等数据转换和组装逻辑。 

  • WebAPI:不走连接类型的调用脚本,根据配置的参数直接组装成http报文调用,复杂逻辑也可以开启脚本模式处理。另外WebAPI也支持根据curl快速导入API模型。


3 关键操作

步骤1:在【集成管理】->【连接管理】->【连接类型】中搜索外部系统名称,如果连接类型有API调用脚本,且已经有该连接类型登记的外部API时,则可以继续复用外部系统API登记。需要确认连接类型是否包含了“API调用脚本”的内容,且外部系统API登记列表已经有该连接类型的外部系统API登记。



步骤2:如果没有预置连接类型的,可以开发新连接类型,但是不需要抽象出公用的API调用脚本,建议直接使用WebAPI登记功能。

 


步骤3:如果有复杂调用逻辑,或者需要在API中引用集成资源时,可以使用自定义API


外部系统API集成路线选择

1 业务场景当用户需要将外部系统的WebAPI登记到苍穹中进行调用时,集成服务云提供了WebAPI登记、自定义API、外部系统API登记三种功能。注...
点击下载文档
确认删除?
回到顶部
客服QQ
  • 客服QQ点击这里给我发消息