集成对象转API介绍

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

集成对象转API介绍

1 简介

1.1 功能介绍

该功能可以将集成服务云中已有的集成资源(集成对象)转换为API。


1.2 应用场景

集成对象转API为异构系统间的业务集成提供统一的API访问机制,将集成云可连接的系统的业务功能快速发布为可供第三方访问的API。


1.3 系统路径

【集成管理】→【API集成】→【API开发】→【集成对象转API】


1.4 字段/按钮说明

字段说明:

字段名称详细解释
编码
集成对象转API的编码
名称集成对对象转API的名称
使用状态
启用/禁用
需要授权
该API是否配置了“需要授权”选项


按钮说明:

按钮名称详细解释
启用/禁用
启用/禁用该API
生成PDF生成该API的说明文档(PDF格式)
生成WORD生成该API的说明文档(Word格式)
批量分类
为选中的API批量进行分类
日志
穿透到“集成API日志”页面
历史版本

查看该API的历史版本,并比对版本之间的信息

不发布到开放平台
该API不发布到苍穹的开放平台
需要授权
进入API授权页面为此API选择调用者,调用url中的参数caller填入调用者编码
禁止记录追溯信息
对于大数据量初始化的功能,建议启用此选项屏蔽追溯功能,以免在执行过程耗费太多数据库存储空间记录追溯信息
校验参数格式
调用时校验输入参数格式是否正确


2 主要操作

2.1 新增API

前提条件

已经同步了需要转换为API的集成对象。


操作步骤

步骤1:选择集成对象及对应的操作类型,如数据表的读取、保存、删除操作,或实体绑定的事件。



步骤2:根据集成对象和操作类型,配置相应的输入输出参数。当操作类型为查询类的动作时,输入参数可以在自定义条件页签配置。以输入参数作为查询的过滤条件,并且输出参数可以配置查询到的所有数据信息。



步骤3:当操作类型为修改类(删除、新增、修改)的动作时,输入参数不能配置自定义条件(无自定义条件页签),且必须设置候选键字段,输出参数固定为idtype操作结果类型



2.2 调试API

操作步骤

步骤1:打开“记录API调用日志”开关,并且根据业务场景配置“API摘要模板”。



步骤2:保存以后可以启用并进行测试。(密码配置方法可参考:SQL执行工具




更多内容:

详细使用指南

集成对象转API介绍

1 简介1.1 功能介绍该功能可以将集成服务云中已有的集成资源(集成对象)转换为API。1.2 应用场景集成对象转API为异构系统间的业务集成...
点击下载文档
确认删除?
回到顶部
客服QQ
  • 客服QQ点击这里给我发消息