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

集成第三方接口(外部API)的使用及其规范

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

集成第三方接口(外部API)的使用及其规范

**为了统一管理外部API,集成服务云提供外部API鉴权、外部API登记、部署外部API资源、微服务调用外部API的功能,下面按顺序介绍各个功能的使用方法及其规范。** ==特别说明:哪些场景的外部API需要改造成集成服务云统一管理,需要苍穹各业务领域根据具体情况分析决定。一般来说,像云之家、钉钉等外部系统的API调用,我们是强烈建议统一连接配置、统一API调用管理的。== # 1、外部API鉴权 ## 1.1 连接器开发(V5.0.020以上版本,通过动态配置鉴权界面) (1)新增连接类型,根据系统类型的不同,在鉴权参数分录添加必要的参数,如app_id,app_secret等。填写后保存,可以查看预览,观察参数界面是否动态加载 ![Snipaste_2023-08-11_17-31-10.webp](/download/0100a1be39b78b4d4331a7c7955d39fbac13.webp) ![Snipaste_2023-08-11_17-31-18.webp](/download/0100ed36ec9f55bb4d2fbd1517a5b41e6e40.webp) (2)编写登录脚本、会话刷新脚本、状态测试脚本 根据将postman调好的登录API,通过代码转换工具生成脚本,并实现变量替换,如图所示。 ![Snipaste_2023-08-11_17-31-43.webp](/download/010037673de464cc488998a9efc9d625224f.webp) ![Snipaste_2023-08-11_17-32-03.webp](/download/0100c06406e26dd346f8b3a85129f14f9f81.webp) ![Snipaste_2023-08-11_17-33-08.webp](/download/010087b897c7801f460580827d1ee7102bda.webp) ## 1.1 连接器开发(V5.0.020以下版本,开发自定义表单) 下面以云之家连接为例,介绍创建一个新连接器的操作步骤。 第一步:创建连接类型,配置连接器工厂类,配置会话登录和会话刷新脚本,可能还需要创建连接配置表单,也可以使用预置的配置表单比如“isc_database_link_webapi”。 ![image.webp](/download/010078745bd063fb458cbc91ac6e5ba3dfb2.webp) 创建好连接类型后,需要导出成dts文件,提交给集成服务云来发布(也可以自行预置到代码resources下,通过调用微服务接口导入)。 ```java DispatchServiceHelper.invokeBizService("isc", "iscb", "IscResourceService", "importResource", "str"); ``` 如果创建了连接配置表单,配置表单的元数据也要一起提交。 ![image.webp](/download/010005aabdc50c7446ecaf50d6261e1531d8.webp) 第二步:创建连接配置,输入API鉴权需要使用的信息,比如域名或者IP、用户名、密码等等。 第三步:为连接配置创建数据源。数据源是为了将集成资源和连接配置解耦增加的一个抽象,后面API注册时会依赖数据源。外部API就是一种集成资源,其他的资源还包括集成方案、服务流程等等。 ![image.webp](/download/010070e131c1ad4d4916ab0d91b15286203b.webp) ## 1.3 创建连接类型的规范 |字段名称|说明| |-|-| |Logo|可以使用默认Logo,也可以提供Logo给到集成云添加。 |编码、名称|使用标识性强的编码、名称。 |所属领域|没有合适的话,选择其他领域。 |顺序号| 苍穹平台使用[2000,3000)的顺序号,财务云使用[3000,4000)的顺序号,供应链和税务云使用[4000,5000)的顺序号,人力资源云使用[5000,6000)的顺序号,制造云使用[6000,7000)的顺序号。 |开发商|业务领域名称。 |配置表单|可以复用已经存在的配置表单,不满足业务则需要新增。 |连接配置操作权限|根据实际业务场景,判断是否允许新增、修改、删除连接配置,不确定时可以先全部勾选。 |连接器工厂类|复用现有的连接器工厂类,比如WebAPi可以使用kd.isc.iscb.platform.core.connector.webapi.WebApiConnectionFactory |描述、版本说明|对连接类型做充分的说明 |脚本配置|会话登录和会话刷新脚本必须配置,API调用脚本和测试脚本可选 |是否预置|是 # 2、外部API登记 ## 2.1 登记云之家获取人员API示例 使用集成云“自定义API”功能来登记外部API,下面是登记云之家获取人员API的示例: ![image.webp](/download/0100d02a13e7cd7c4b9ba2fa78ce4a734a56.webp) ![image.webp](/download/01004b869b3f7f4042cf8c087d52128c386e.webp) API调用脚本如下: ``` //cn是依赖的数据源连接,通过cn可以访问连接配置的信息,还可以通过cn.$session访问鉴权返回的信息 var protocal = cn.http_protocal; var ip = cn.server_ip; var port = cn.server_port; var token = cn.$session.accessToken; var url = $$("#{protocal}://#{ip}:#{port}/gateway/openimport/open/person/getall?accessToken=#{token}"); var data = {}; data.begin = begin; data.count = count; var user = cn.user; var param = String.URLEncode(String.FormatJson(data)); var params = $$("eid=#{user}&data=#{param}"); //HttpAccess是集成云脚本提供的Http请求方法 var response = String.ParseJson(HttpAccess(url,"GET",params,"UTF-8",null,null,100000).result); if(!response.success){ throw response; }else{ //person 是API的输出 var person = response.data; } ``` ## 2.2 操作步骤 第一步:建议先在类似Postman工具中测试API通过,并复制cURL命令。 第二步:通过集成云提供的代码转换工具(暂时需要在开发平台搜索isc_convert_code表单,此功能在集成云2022.11.28的版本中优化),将cURL命令转换成集成云脚本,在脚本执行工具中测试通过后,可直接作为下一步创建自定义API的脚本。 ![image.webp](/download/0100b57183c1d141416dba02fbea9b27cb4a.webp) ![image.webp](/download/0100265cd2d639434c60aae884c9731446ca.webp) 第三步:创建自定义API,依赖资源选择前面创建的云之家数据源(包含连接配置和鉴权信息),调用脚本使用上一步复制的脚本。还可以通过Json导入输入参数和输出参数,生成结构化的输入和输出。 ![image.webp](/download/010098906ca474814e858382f540a29b8793.webp) 第四步:测试登记的API。 ![image.webp](/download/01006e0b51a9c08a42efa82748a04aeb4a86.webp) ## 2.3 使用

集成第三方接口(外部API)的使用及其规范

**为了统一管理外部API,集成服务云提供外部API鉴权、外部API登记、部署外部API资源、微服务调用外部API的功能,下面按顺序介绍各个功能的...
点击下载文档文档为doc格式

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

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