自定义API介绍

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

自定义API介绍

1 简介

1.1 功能介绍

通过引入不同集成资源(数据源、服务流程等),并结合集成服务云的脚本引擎,可以编写API脚本。这样,就能灵活地定义数据处理方式,降低了在多系统之间存储和获取数据的难度。


1.2 应用场景

用户可以复用集成云中已有的集成资源,并将这些集成资源包装成API供外部系统调用。


1.3 系统路径

【集成管理】【API集成】【API开发】【自定义API】


1.4 字段/按钮说明

字段说明:

字段名称详细解释
编码自定义API的编码
名称自定义API的名称
使用状态启用/禁用
需要授权
是否需要授权才可调用(API调用者
是否预置是否为应用预置的API
开发商
API开发方标识,格式为:开发商标识(预置API为:开发商.业务云
保护等级
该资源的保护等级:默认、只读、无保护(空作为默认
来源
记录最后一次编辑该API时的租户ID


按钮说明:

启用/禁用
启用或禁用该API
生成PDF/WORD生成该API的调用说明,包括调用路径、入参、出参等
导出API
导出该API的dts文件
导入API
将自定义API的dts文件导入生成自定义API
根据WSDL文件导入
导入WSDL文件并选择具体的操作生成自定义API
根据WSDL URL导入填写WSDL文件的URL路径生成自定义API


2 主要操作

2.1 新增自定义API

前提条件

已经在集成服务云中配置了相关资源,如数据源、集成方案等。


操作步骤

步骤1:新建自定义API,并在依赖资源中引用需要用的资源。



步骤2:根据业务需求配置输入输出参数。




步骤3:编写自定义API脚本。(脚本学习


   



2.2 资源引用关系查看

选中对应的自定义API,从“更多”按钮下拉框中可点击“资源引用关系”按钮,查看当前自定义API所有的依赖资源及其引用关系图。



以当前启动方案为主资源,可以查询到其上游的服务流程。



点击对应的资源块,可以查看详细的节点内容。



2.3 通过WSDL创建API

操作步骤

1、在“导出API”的下拉项中点击“根据WSDL文件导入”按钮或“根据WSDL URL导入”按钮。



2、点击“根据WSDL文件导入”阿牛,弹出上传界面,选择想要导入的WSDL文件。

注:此处也可以直接粘贴WSDL文件内容到wsdl编辑器。



3、点击“解析”按钮,对WSDL文件内容进行解析,手动选择想要生成API的操作。



4、在自定义API的表单页面选择发布到开放平台的版本。

注:当所选的“开放平台版本”是2.0时,请确认WebService信息是否正确。



5、发布到开放平台2.0的API,支持JSON、XML、SOAP1.1、SOAP1.2这四种格式或协议的报文调用。



2.4 设置保护等级

1、自定义API支持设置保护等级为:默认、只读、无保护。

  • 默认:当系统参数【集成云保护策略】关闭时,生产环境不允许修改/删除/复制,非生产环境可以修改/删除/复制; 

  • 只读:任何环境下都不允许修改/删除;

  • 无保护:任何环境下都可以修改/删除/复制。

注:系统参数路径:【系统服务云】【配置工具】【系统参数】集成云资源保护策略】



2、当自定义API修改时,来源字段填充当前租户ID来源追溯末尾以分号分割拼接租户ID。

注:来源字段和当前租户ID一致时,作为无保护级别处理。



2.5 导入覆盖控制

自定义API导入覆盖遵循以下原则:

  • 本地资源不是导入资源的历史版本时,导入将忽略。

(如本地资源的来源追溯是A;B;,导入资源的来源追溯是A;C;)


  • 本地资源是导入资源的历史版本,导入资源在其他环境修改过,且“资源反向导入”开关未开启,则导入时将忽略;“资源反向导入”开关开启,则可以导入。

(如当前环境租户ID是A,本地资源来源追溯是A;B;,导入资源来源追溯是A;B;C;)

注:“资源反向导入”开关路径:【系统服务云】【配置工具】【系统参数】集成云资源保护策略】



更多内容:

自定义API使用说明

自定义API介绍

1 简介1.1 功能介绍通过引入不同集成资源(数据源、服务流程等),并结合集成服务云的脚本引擎,可以编写API脚本。这样,就能灵活地定义...
点击下载文档
确认删除?
回到顶部
客服QQ
  • 客服QQ点击这里给我发消息