管理主数据接口

1.概述

主数据接口管理模块展示了系统内置的主数据接口信息，包括主数据模型的查询接口，以及数据的查询、申请、修改、冻结、解冻等接口，这些接口可以直接提供给第三方业务系统调用，实现第三方业务系统以接口的形式进行主数据的访问和维护。

在主数据接口管理模块，除可查看接口说明外，还支持在线测试接口，以及新增接口。

2.查看主数据接口

在主数据接口列表中，点击【查看】即可进入该接口使用说明页面。

在接口使用说明页面，我们可以了解到接口链接、用途、请求参数以及其含义，方便技术人员快速了解主数据接口的调用方法。

3.测试主数据接口

点击主数据接口列表中的【测试】按钮即可进入该接口的测试页面。

在接口测试页面，先选择【请求类型】，然后按照接口要求输入【请求参数】或者【请求体】，再点击【查询】，最后在响应数据区域可以查看到返回的数据。

接口的请求类型一般分为2种，GET请求和POST请求，对GET请求的接口测试，需要输入请求参数才能返回数据；对POST请求的接口测试，除了输入请求参数外，还需要输入请求体才能成功执行。

3.1.GET接口

这里以【主数据查询】接口为例来演示GET接口测试的步骤。需要查询的数据为【内部人员】模型里的“xx集团”下员工“王五”的人员信息。

先看看主数据查询接口需要的参数：

（1）Id：用户名

是指登录主数据平台需要的账号，可直接使用默认值admin

（2）Pw：密码

是指登录主数据平台需要的密码，可直接使用默认值admin

（3）masterId：主数据模型ID

是指查询的主数据模型ID，在主数据模型管理页面，点击【内部人员】模型，可查看到该模型的模型ID：86caf8b807054724a6ccdc447a0865d9

（4）sysId：主数据数据ID，系统内置SYS_ID_字段

是指查询的主数据的系统内置主键SYS_ID_字段的值，可直接在视图管理页面，点击基本信息视图的数据库表名进入数据库表查询页面，可找到对应数据的SYS_ID_字段对应的值：d0fd2a664cf540ec859567b0f673e4f1

（5）convertCase：数据节点转换大小写，true转换成大写，false转换为小写，为空保持不变

是指返回的json串节点是否显示大写还是小写，这个可以根据第三方系统的实际需求给参数赋值，这里我们直接为空。

将以上参数值输入到对应的请求参数框中，点击查询可在响应数据区域展示以json格式的王五员工信息数据了，说明接口测试成功。

3.2.POST接口

这里以【主数据修改】接口为例来演示POST接口测试的步骤。测试接口实现修改【内部人员】主数据里的“xx集团”下的员工“王五”的姓名为“王五2”

先看看主数据修改接口需要的参数：

（1）Id：用户名

获取方式同GET接口测试里的id参数

（2）Pw：密码

获取方式同GET接口测试里的pw参数

（3）masterId：主数据模型ID

获取方式同GET接口测试里的masterId参数

（4）sysId：主数据数据ID，系统内置SYS_ID_字段

获取方式同GET接口测试里的sysId参数

按照以上方式获取的参数值输入到接口测试界面的请求参数值中。

（5）请求体

切换到请求体，按照以下json格式输入请求体，也就是按照格式整理出主数据模型的视图代号、各字段名称以及修改后的值。可以看到下面代码中已经录入了姓名字段为“王五2”。

{

    "NBRY_XXB":[

        {

            "SYS_ID_":"ece3ccd13f994dc1839e6bf95d040ddf",

            "YGBM":"YS000001",

            "XM":"王五2",

            "CYM":"",

            "DWBM":"00",

            "XB":"1",

            "ZJLX":"",

            "ZJH":"",

            "ZP":"",

            "LXDH":"15871800322",

            "CSRQ":"",

            "DACSRQ":"",

            "MZ":"",

            "ZZMM":"",

            "RDTRQ":"",

            "GJ":"",

            "JG":"",

            "HJDZ":"",

            "HKXZ":""

        }

    ]

}

然后点击查询，最后响应数据中返回了该数据的SYS_ID_值，说明接口测试成功。

最后到主数据维护模块的主数据申请界面可查看到该员工的姓名已经成功被修改。

4.新增主数据接口

根据实际的业务需要，在主数据平台定制开发的新接口或者是第三方业务系统提供的接口可以在主数据接口管理模块进行新增，方便接口信息的统一查看和管理。

点击新增按钮，在弹出的对话框中，输入接口的基础信息和参数值即可。

5.删除主数据接口

对于系统内置的接口不可以删除，用户新增的接口支持删除，勾选新增的接口，点击删除即可。