数据集成方案转API介绍

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

数据集成方案转API介绍

1 简介

1.1 功能介绍

为提高集成平台的扩展性,集成云将部分接口封装为API供外部系统调用。集成方案API基本接口包括:查询、转换、推送、执行,业务可以根据自身需求选取。


1.2 应用场景

当业务现场已经配置了数据集成方案,且希望复用该集成方案,可以将其转换为API供外部系统调用。


1.3 系统路径

【集成管理】【API集成】【API开发】【数据集成方案转API】


1.4 字段/按钮说明

字段说明:

字段名称详细解释
类型

从来源系统‘取数推送’到目标系统

从来源系统‘取数并转换’为目标单数据

将源单数据‘转换后并推送’到目标单系统

将源单数据‘转换’为目标单数据

需要授权该API是否需要配置调用者才能调用
使用状态
启用/禁用


按钮说明:

按钮名称详细解释
生成PDF
生成API的说明文档(PDF格式)
生成WORD生成API的说明文档(WORD格式
批量分类
批量对选中的API进行分类
失败时继续默认为不勾选,一条数据异常,则立即结束,并返回异常信息,且包含已成功信息堆栈;勾选,则忽略该条异常,继续执行下一条数据,且返回所有堆栈信息


2 主要操作

2.1 新建取数API(PULL)

前提条件

已经有数据集成方案。


操作步骤

  • 新建数据集成方案转API,类型选择从来源系统‘取数并转换’为目标单数据



  • 输入:集成方案的参数值

  • 输出:转换后的目标单数据

注意:应在方案中设置合适的过滤条件,避免一次性返回太多数据行,每次最多可以取1000行数据。


接口地址:/kapi/app/iscb/{api_number}

请求方式:POST

Header参数:

Content-type: application/json

access_token: 登录苍穹拿到的access_token,根据实际情况填写

请求body参数:

如果集成方案有则按实际填写,否则传递一个空map。


2.2 新建转换API(TRANSFER)

前提条件

已经有数据集成方案。


操作步骤

  • 新建数据集成方案转API,类型选择将源单数据‘转换’为目标单数据



  • 输入:源单数据

  • 输出:转换后的目标单数据

接口地址:/kapi/app/iscb/{api_number}


2.3 新建推送API(PUSH)

前提条件

已经有数据集成方案。


操作步骤

  • 新建数据集成方案转API,类型选择将源单数据‘转换后并推送’到目标单系统



  • 输入:输入源单数据data(可以为列表)

  • 输出:各数据的执行结果id, type, errorMessage,如果一条数据异常,接口将终止

接口地址:/kapi/app/iscb/{api_number}


2.4 新建执行API(EXECUTE)

前提条件

已经有数据集成方案。


操作步骤

  • 新建数据集成方案转API,类型选择 从来源系统‘取数推送’到目标系统。



  • 输入:源单过滤条件

  • 输出:各数据的执行结果id, type, errorMessage,如果一条数据异常,接口将终止

接口地址:/kapi/app/iscb/{api_number}


更多内容:

详细说明

数据集成方案转API介绍

1 简介1.1 功能介绍为提高集成平台的扩展性,集成云将部分接口封装为API供外部系统调用。集成方案API基本接口包括:查询、转换、推送、执...
点击下载文档
确认删除?
回到顶部
客服QQ
  • 客服QQ点击这里给我发消息