电脑桌面
添加蚂蚁七词文库到电脑桌面
安装后可以在桌面快捷访问

妈见夸,三分钟内搞定查询接口开发!

来源:金蝶云社区作者:金蝶2024-09-232

妈见夸,三分钟内搞定查询接口开发!

在IT项目中,我们常常需要和外部系统打交道,除了对接第三方系统的API外,还常常要提供开放接口给第三方系统调用。


那么,怎样能够快速设计并开发一个API,满足安全、灵活、易扩展等多方位需求呢?


今天就以苍穹对外开放查询人员主数据API为例,列举一些常见的场景,以及如何在系统内快速完成开发。欲知详情,请往下看。




1 适用版本


该功能适用版本为金蝶云·苍穹V5.0.011及以上。


2 功能场景


2.1 根据工号查询人员信息


借助苍穹开放平台,用户可以快速配置人员主数据接口。


路径:【开发服务云】→【开放平台】→【API管理】→【API开发】列表,点击“新增”按钮,进入到零代码开发模式。


上传图片

开放平台新增操作API


依次维护API编码、名称、请求方式等信息,选择业务对象“人员”,操作方式“查询”。随后,定义请求入参,可以通过添加属性快速完成添加,也可以通过点击“增行”,手工输入。


注:此处参数名称可以根据需要自定义


上传图片

维护API基本信息和请求参数


请求入参定义完后,可以直接在页面配置查询接口执行逻辑和返回参数。根据业务对象中的字段和请求入参进行比较,常见的比较方式有“等于”“不等于”“在...中”等等,接口根据入参变化接口返回不同的数据,如下图所示:


上传图片维护参数控制和返回参数


上述步骤维护结束后,一个查询API就开发完毕了。接下来就可以点击“API测试”按钮,测试接口功能,如下图所示:


上传图片

API在线测试


2.2 自由组合查询条件,查询人员信息资源更新


在场景一中, 用户可以通过“添加属性”,将第三方系统需要的字段添加到返回参数中,包含人员所有的基本信息和分录信息,出参调整非常灵活。那么如果想要更灵活的入参,应该怎么办呢?


只需要在定义查询条件时,配置多组不同的查询条件,如根据人员状态、创建时间和性别来查询人员信息。


上传图片

配置多组请求参数和组合条件


若想要调用方在不传某项参数时,接口自动忽略该参数和条件,按剩余条件进行过滤,只需要将参数设为“非必填”,并且设置默认值为“*”即可。


当然,有些参数有具体含义的默认值,比如说,当调用方不传”性别“时,接口默认传的是0,如下图中:


上传图片维护请求参数默认值


设置完成后,可以测试效果。此时,调用方只传了一个时间参数,但接口执行时,过滤条件(filter)会忽略默认值为“*”的参数

妈见夸,三分钟内搞定查询接口开发!

在IT项目中,我们常常需要和外部系统打交道,除了对接第三方系统的API外,还常常要提供开放接口给第三方系统调用。那么,怎样能够快速设计...
点击下载文档文档为doc格式

声明:除非特别标注,否则均为本站原创文章,转载时请以链接形式注明文章出处。如若本站内容侵犯了原著者的合法权益,可联系本站删除。

确认删除?
回到顶部
客服QQ
  • 客服QQ点击这里给我发消息
QQ群
  • 答案:my7c点击这里加入QQ群
支持邮箱
微信
  • 微信