5分钟教你轻松拿捏外部API测试
许多第三方应用系统出于数据安全和通用性的考虑,对外只提供WebAPI用于系统之间的集成。通过集成服务云,用户可以根据不同系统的鉴权流程和接口调用方式创建连接类型,并根据调用路径和出入参登记好外部系统接口。在整个配置过程中任何细小的疏漏都可能导致最后接口调用失败,因此在苍穹与第三方应用系统集成时,如何快速验证苍穹中登记接口的准确性就变得尤为重要。
那么,在集成云对接外部系统时,如何快速、高效、准确地测试/验证登记好的API呢?接下来,可以跟随小编的讲解,从功能的认知和方案配置等方面逐步学习,让你轻轻松松拿捏集成云API测试!
1 API测试功能简介
1.1 设计说明
将第三方系统的API登记为集成云的WebAPI或外部系统API并启用后,可利用集成云API测试功能,通过可视化页面,传入对应API的参数,发起请求进行验证。
1.2 系统路径
路径一:【集成管理】→【API集成】→【WebAPI登记】→【测试】
路径二:【集成管理】→【API集成】→【外部系统API登记】→【测试】
1.3 前期准备
登记为“WebAPI”时,测试功能使用无需填写对应“集成云测试密码”
登记为“外部系统API”时,需要使用“集成云测试密码”,该参数只允许在私有云环境中设置,因此公有云需要借助postman工具联调测试。
2 API测试方法
场景一:使用WebAPI登记
1) 登记WebAPI,并启用相应API;
2) 列表/表单页面点击“测试”按钮。
注:WebAPI测试只有在测试或者开发环境才能执行,或者isc_debug_mode设为true。
WebAPI登记页面
WebAPI测试页面
场景二:使用外部系统API登记
1) 登记外部系统API,并启用相应API;
以下分两种情况:
场景一:对应外部系统API勾选了“不发布到开放平台”。
外部系统API登记示例
点击“测试”,输入API参数后,需要输入对应“集成云测试密码”及相应“代理用户密码”进行测试。
注:集成云测试密码设置见文末链接。
外部API测试页面
场景二:对应外部系统API未勾选“不发布到开放平台”,即在集成云注册的API启用后会发布到开放平台,作为当前苍穹系统对外开放的API。
外部系统API登记示例
同理,点击“测试”,输入API参数后,需要输入对应“集成云测试密码”及相应“代理用户密码”进行测试。
外部API测试页面
注意:由于很多客户是公有云,无法设置对应“集成云测试密码”,因此在当前场景下,可利用上图测试功能页面中的URL信息及令牌信息,通过postman工具来测试相应API。方法如下:
1) 复制测试页面的URL信息和参数信息,如下图:
复制测试页面的URL信息和参数信息
2)获取access_token。一般是先获取到appToken,然后根据appToken获取到access_token,获取后将access_token拷贝到PostMan作为请求参数,详细方法见文末。
3)将上述信息复制到Postman工具中进行测试。
通过postman工具测试API
3 注意事项
建议使用WebAPI登记功能来登记和调试第三方系统API。
如果使用外部系统API登记,公有云不允许设置“集成云测试密码”。因此,当API在集成云登记为外部系统API时,仅能借助postman工具联调测试。
4 划重点
WebAPI登记为集成云BIZ_V5.0.017版本发布的新特性,该功能可快速通过curl导入,将第三方系统的API注册在集成云,并可通过开启“脚本模式”对调用脚本进行灵活处理:
https://vip.kingdee.com/article/416603137886383360
WebAPI测试只有在测试或者开发环境才能执行,或者isc_debug_mode设为true。
使用postman联调外部系统API登记方法见文档:
https://vip.kingdee.com/article/418455786692531200
access_token获取方法见文档:
https://vip.kingdee.com/article/218694224386822400
测试密码设置方法见文档:
#往期推荐#
更多精彩内容,“码”上了解!↓
5分钟教你轻松拿捏外部API测试
本文2024-09-23 00:50:37发表“云苍穹知识”栏目。
本文链接:https://wenku.my7c.com/article/kingdee-cangqiong-142100.html