2第三方应用接口库
2.1概述
第三方应用接口库主要是提供外部集成资源的注册与测试平台,将外部接口基础信息和请求地址、参数、协议等元数据化,变成可配置,降低集成客开成本,甚至零代码集成。
2.2规范
第三方应用接口库支持的接口远程协议包括:WebService/Rest/JCO/Http.
具体规范:
1、WebService是根据WSDL文件进行自动解析的,所有必须具有WSDL文件
2、WebService自动解析不支持复杂类型的参数
3、HTTP/REST接口下返回参数最多只能配置一个(可以是xml或JSON等复杂类型)
4、Content-type为text/xml或application/json时,传入参数最多只能配置一个(可以是xml或JSON等复杂类型)
5、认证引用不能多次引用同一个认证接口
6、不能交叉引用认证接口,比如接口A(本身为认证接口)引用了认证接口B,则B不能再引用认证接口A
2.3注册接口
2.3.1创建接口分类
接口分类第一级默认显示第三方应用中的等级产品,按产品编码+版本号显示
接口不能创建在一级分类下
点击新建接口,进入新建接口向导
2.3.2接口基本信息
授权控制默认不控制,不可编辑
2.3.3接口描述
只有预置接口有接口描述,客户自定义接口接口描述不可录入
2.3.4语义定义
接口元数据化的核心
2.3.4.1语义定义基础信息
接口访问协议:根据实际接口选择,主要分WebService、rest、JCO和HTTP
WebService协议
接口服务地址需要以?wsdl结尾,接口方法通过点击wsdl选择按钮,上传wsdl文件进行选择,如下图
选中接口方法后,传入参数和返回参数能够自动解析出来(WebService暂不支持复杂参数类型),且参数不可以新建和删除。如下图:
JCO协议 需要设置函数名和JCO连接信息,如下图:
HTTP/REST略
接口应用类型:
导出接口A8数据导出
取数接口从第三方系统取数
认证接口取认证令牌或做握手使用
页面跳转不做实际接口调用,返回接口地址和传入参数,一般用于单点登录
接口服务地址:接口地址,http://或https://开头,JCO接口没有接口服务地址,接口地址支持使用${XXX}引用变量,如下图:
在接口测试和接口具体引用时可以对该变量进行赋值,详情见接口测试和接口引用
HTTP/Rest/Webservice接口基础信息:
Content-type:接口传递数据格式,WebService默认为text/xml
编码:即charset
请求方法:接口请求方法,WebService默认为POST
2.3.4.2传入参数设置
即接口入参设置,参数类型分预置类型和自定义类型,
预置类型:参数数据类型包括string(字符),decimal(数字),boolean(布尔类型),date(日期类型),string[] (字符数组),decimal[] (数字数组),XML,JSON,JSONArray,JcoStructure,JcoTable。其中JcoStructure,JcoTable类型只有在JCO接口类型中才允许设置,如下图:
自定义类型:约束如下
当数据类型选择XML,JSON,JSONArray,JcoStructure,JcoTable时,可以进行二级参数格式设置,如下图:
Xml参数格式设置
新增XML标签
标签名:xml标签名
属性:xml标签属性,可以设置多个属性,可以设置属性值,也可以不设置属性值,未设置属性值的属性在接口测试和接口引用赋值时可以对该属性进行赋值,如下图:
数据类型:支持string,decimal,date,boolean
数据规范:数据类型为string类型时,数据规范填写string字符最大长度;数据类型为decimal类型时,数据规范填写数值小数位长度;数据类型为date类型时,数据规范下拉框选择日期格式;数据类型为boolean时,无数据规范
是否必填:参数的必填性,接口调用时会检验接口参数的必填项;xml参数中,只有末级标签能设置必填
是否重复:标签设置可重复时表示,标签本身及所有下级标签都是可重复的,可以选择映射表单的重复表数据,一般作为单据的表体使用。
Xml参数格式可以使用xml模板导入一键创建,如图:
设置完xml参数格式后,可以查看是否设置正确,如图:
JSON和JSONArray参数格式设置
数据类型:包括string,decimal,date,boolean,JSON和JSONArray
JSONArray(JSON数组)是否可重复默认为是,JSON格式下可以再设置JSON和JSONArray数据,JSONArray下可以再设置JSON数据,JSONArray下不可以设置JSONArray数据。设置完后可查看结果,如图:
JCOStructure和JCOTable参数格式设置
包含二级参数名,数据类型,数据规范和是否必填属性
2.3.4.3返回参数设置
即接口返回数据设置,基本同传入参数设置,不赘述
2.3.4.4错误与提示设置
主要是设置成功标识、警告信息、错误提示信息及错误提示信息的转义
成功标识、警告信息、错误提示信息均从返回参数中选择,返回参数如果为XML或JSON或JSONArray或JCOStructure或JCOTable类型时,则可以从二级节点选择,如下图:
2.3.4.5认证信息(认证引用)
支持单次认证、多次认证和多级认证引用
单次认证:
多次认证:
多级认证指引用的认证接口本身也有引用认证接口
其中:认证参数默认带出引用认证接口的认证令牌,且可手动编辑;有效时长自动带出认证接口认证令牌的有效时长,不可编辑。
详细的认证接口选择和参数赋值可以查看接口引用—接口匹配说明。
认证参数在接口参数赋值时可以使用,如图:
2.3.4.6认证接口
接口应用类型为认证接口时,认证令牌和有效时间为必填项。
认证令牌:从一级返回参数或二级返回参数中选择,上图就是选择的二级参数的id节点
有效时间:认证令牌的有效时间,超过时间自动重新获取令牌,以分钟为单位
2.3.5接口测试
1)提供注册接口的测试平台。
2)用户选择应用系统并指定测试参数,可实现无代码接口测试
3)支持测试数据的版本管理
接口测试有两个入口:1.接口创建成功后可直接进入接口测试;2.编辑接口-接口测试页签
如下图:
应用系统当前版本应用系统
参数—参数自动带入接口设置的传入参数以及接口地址中使用的${XXX}引用的变量
点击接口测试后,结果自动写入返回值或者测试结果中。
可以将当前参数赋值保存为历史用例,以后可以直接选择对应历史用例用于接口测试。
2.4接口引用
2.4.1接口匹配
第一步:目标应用选择
选择目标接口所在产品对应的应用注册
第二步:目标接口选择
第三步:参数赋值
目标接口选择后,会自动带出该接口配置的传入参数以及${XXX}引用的变量,点击右侧参数赋值位置可以打开赋值对话框进行赋值,如下图:
参数赋值数据域包括:表单数据域,流程变量,审批意见,事件关联数据,产品定义参数,SeeyonConfig参数,系统全局变量,认证数据
1)表单数据域关联表单的所有字段,分主表和重复表;
2)流程变量对应流程的相关信息;只有CIP业务流程集成中能引用
3)审批意见支持本节点和所有节点审批意见;只有CIP业务流程集成中能引用
4)事件关联数据 对应事件的所有数据;只有事件引用中能使用
5)产品定义参数第三方应用—产品登记中设置的所有产品参数
6) SeeyonConfig参数所有CIP集成平台涉及的SeeyonConfig参数配置参数
7)系统全局变量当前登录人以及当前时间的相关信息
8)认证数据目标接口引用的认证接口—认证参数选择
XML、JSON、JSONArray、JCOStructure和JCOTable格式参数赋值:
显示可赋值的输入框可以点击进行赋值,如下图:
2.4.2应用接入引用接口
用户绑定
消息集成引用CIP接口库
待办集成引用CIP接口库:
单点登录引用CIP接口库:
2.4.3事件引用接口
赋值数据可以选择事件关联数据
2.4.4认证引用接口
目标接口只能选择对应应用下的认证接口
2.4.5超级节点引用接口
2.4.6节点事件引用接口
2.4.7流程事件引用接口
2.5共享与预置
2.5.1共享
即支持CIP接口库的导入导出,使不同A8系统下的接口库可以复用共享。
导出:
导入:
导入的CIP接口库可以在集成维护—CIP组件管理中查看,如下图:
2.5.2预置
第三方应用接口库中主要针对NC6.5版本提供了大量预置接口,主要包含接口如下图: