外部系统API登记常见问题
背景:随着业务场景的特殊和复杂,需要使用API进行集成的场景越来越多,然而集成云的WebAPI连接器在配置的过程中可能会遇到一些问题,本篇针对一些常见现象进行一些QA段落,争取快速掌握API的各种配置,加速项目进度。
阅读本文时已经认真看过https://club.kdcloud.com/school/171921047992997888和https://club.kdcloud.com/school/61461018178089216两篇内容,对集成云脚本有一定程度了解,懂得使用脚本帮助手册,但是仍然无法让整个流程运转起来。
1. 当进入集成云配置外部系统API之前我需要做什么?
使用postman测试外部API是否可以调通,如果不可以,需要再次阅读三方系统的API文档,检查自己是否遗漏。图中为天气网查看广东省天气API。
2. 外部数据源的API和集成对象在测试时在集成云是怎么运转的?
登记好的API与集成对象点击测试时会先进入连接类型会话登录脚本,再进入API调用脚本。
在一般的配置场景,是在会话登录脚本里获取token,在API调用脚本里取到token后访问外部系统,接收外部系统的返回结果作为输出,会话刷新脚本的作用是当token存在失效时间时,需要配一个刷新时间($refreshTime)比token的失效时间提前一点。
3. 我根据新建的连接类型创建的连接怎么也无法测试成功?
创建的WebAPI连接器在测试时会进入连接配置的服务器状态测试脚本,需要在这里写登录脚本。一般建议将登录脚本的内容写在测试脚本里,return true;代表与第三方系统连接测试成功。
4. 如何在连接类型脚本里取到我需要的一些参数?
此处只列举一些简单常用的,更复杂的内容需要参考问题1的帖子获取。
$protocal(连接配置登记的HTTP协议),$ip(连接配置登记的服务器IP地址或域名),$port(连接配置登记的Web服务端口),$user(连接配置登记的用户名),$password(连接配置登记的登录密码),$data_center(账套(数据中心))。$service(集成对象的全名、外部系统API的接口标识),$params(集成对象、外部API的输入参数,Map格式)。
5. 测试、登录的脚本一直不通,我无法分析问题到底出在哪一步?
首先确保可以通过postman调通,那么出现这个问题的可能原因有以下几点
(1)Http请求方法选择错误
(2)默认的Http字符集、请求头无法满足对方要求
(3)请求Url、参数在脚本中拼接错误等等。
在连接类型的调试过程中,需要合理利用脚本执行工具,可以极大的增加效率。
针对问题(1)与问题(2)的解决办法,需要在脚本执行工具中调试。参考postman调通的url和输入参数,在脚本帮助手册选择合适的Http函数,在脚本执行手册调通之后可以将调用的代码粘贴到测试、登录脚本,此时验证连接配置是否可以测试通过。
如果仍然不通那极大可能是url拼接错误,在服务器状态测试脚本或者登录脚本增加一行throw url;(url是Http函数调通的第一个参数),然后再次测试可以检查url是否正确。
经过以上步骤排查,基本可以调通。
6. API调用脚本一直不通,我无法分析问题到底出在哪一步?
注:当throw的对象是Map结构时,会调用Map的toString方法,例{a:1}->{a=1}。
与问题6分析思路一样,首先保证API在postman可以调通,然后将url和输入在脚本执行工具可以调通。
一般出现这个问题大多数是由于url拼接错误导致,可以通过脚本帮助手册的String的一些函数处理字符串,通过$service和$params获取全名接口标识和输入参数,分别通过throw出来url和param,分别排查问题。
7. 外部API测试成功后,我如何将API引入服务流程?
在服务流程中作为资源引入,通过别名调用或者API节点调用即可,需要定义一个流程变量接受外部api的输出结果。
8. 为什么服务流程里调用的外部API输出结果与在外部API测试时的结果不同?
这是由于当外部API在服务流程中引用时,直接走的内部接口,没有经过平台再包一层data,而是直接将外部API的返回结果输出到流程中。
API入门培训:https://club.kdcloud.com/school/171921047992997888
API入门应用:https://club.kdcloud.com/school/190061346522795008
API高级应用:https://club.kdcloud.com/school/61461018178089216
集成服务云使用指南:https://club.kdcloud.com/article/45312
集成服务云新特性发布汇总:https://club.kdcloud.com/article/146134
集成云常见问题处理合集: https://vip.kingdee.com/article/45556
外部系统API登记常见问题
本文2024-09-23 00:50:07发表“云苍穹知识”栏目。
本文链接:https://wenku.my7c.com/article/kingdee-cangqiong-142033.html