# 第三方接口管理

接口管理模块提供维护三方接口的基本信息及出入参结构,提供测试以及调用日志记录。 使用时需要配置接口并结合工具类调用(需要按配置的入参结构解析,传入真实的业务数据再进行调用),工具类使用请见接口调用工具类

# 第三方接口配置

# 1. 概述

接口配置模块为平台提供统一的第三方系统接口信息维护功能,主要功能包含: 查询新增编辑删除接口查看接口测试导入导出数据日志数据生命周期

# 2. 查询接口配置

【菜单路径:】系统管理–->接口管理–->接口配置

接口配置可以根据编码、名称、应用系统进行检索。应用系统下拉列表来源自第三方应用。

接口配置

# 3. 新增接口配置

点击新增按钮,跳转至添加接口配置页面,如下图所示:

新增接口配置

  • 接口配置信息说明
属性名        属性说明
编码 接口编码,唯一。必填项
名称 接口名称,必填项。
类型 接口类型。restful、soap
方式 请求方式。post、get
应用系统 接口所关联的第三方应用,必填
接口url 接口地址的路径(应用维护的后端地址+接口url为最终路径)。必填。例:/api/plateNumber/index或/WebServices/IpAddressSearchWebService.asmx?wsdl
方法 接口方法名。当类型为soap时显示,必填。
命名空间 接口的命名空间(即targetNamespace)。 当类型为soap时显示,必填。
结果节点 接口返回数据的接收节点,用于数据解析。当类型为soap时显示。
超时响应 接口的最大响应时长。
是否启用 接口是否启用。true/false
请求参数 请求参数包含请求头params参数SOAP标头请求体form-url参数。当类型为restful:方式为post,显示请求头请求体form-url参数;方式为get,显示请求头params参数。当类型为soap:显示请求头SOAP标头请求体
返回参数 返回参数的结构维护。
示例数据 示例数据。可用于假数据功能测试。

注意

form-url参数:指当请求方式为post时,接口入参类型需要为x-www-form-urlencoded(键值对形式)的请求方式。
请求体:指body参数的层级结构

# 4. 编辑接口配置

通过点击表格行的编辑按钮跳转修改页,来对接口配置信息进行修改。如下图所示:

编辑接口配置

接口配置信息详见上文新增接口配置

# 5. 删除接口配置

删除接口配置的数据,包含单条数据删除和多条数据删除。

  • 单条删除

点击某一条记录后的【删除】按钮,弹出删除确认框,点击【确定】执行删除操作。

单条数据删除

  • 多条删除

勾选一条或者多条记录,点击【删除】按钮,弹出删除确认框,点击【确定】执行删除操作。

多条数据删除

# 6. 查看接口配置

通过点击表格行的查看按钮跳转查看页。如下图所示:

查看接口配置

# 7. 接口测试

点击某一条记录后的【测试】按钮,弹出页面。如下图所示:

接口配置日志

测试页面提供参数生成和调用。部分参数需要自填补充。

# 8.导入接口配置

接口配置提供表格的导入功能,点击导入下载模板,维护数据选择导入类型即可导入接口配置数据,详情参考导入流程

# 9.导出接口配置

接口配置提供表格的导出功能,点击导出按钮选择需要导出的字段,即可导出接口配置数据,详情参考导出流程

# 10.接口配置数据日志

接口配置提供数据日志的查询功能,点击数据日志按钮即可进入数据日志列表页面,详情参考数据日志

# 11.接口配置数据生命周期

接口配置提供生命周期的查看功能,勾选表格行选中框,点击生命周期即可查看该条数据的生命周期信息,详情参考生命周期

# 第三方接口日志

# 1.概述

接口日志记录了接口调用的详细信息。主要功能包含查询详情清空审核


提示
接口日志仅保留最近6个月的日志。

【菜单路径:】系统管理–->接口管理–->接口日志

# 2.查询接口日志

接口日志可以根据接口的编码、名称、耗时、应用系统、执行时间、审核状态、是否成功来查询,默认查询一周内的数据。如下图所示:

# 3.查看日志详情

支持查看每条接口日志的详细信息。如下图所示:

# 4.清空接口日志

根据条件查询出日志数据后,点击清空按钮,将已查询的日志数据清空。如下图所示:

# 5.审核接口日志

对于日志管理员可以进行审核。支持单条日志审核,也支持多条日志同时审核。如下图所示:
单条审核:

多条审核: