开发者学堂课程【低代码开发师认证课程:连接企业资产管理系统实践】学习笔记,与课程紧密联系,让用户快速学习知识。
课程地址:https://developer.aliyun.com/learning/course/1046/detail/15214
连接企业资产管理系统实践
内容介绍
二、连接器工厂——连接器开发、管理
二、连接器工厂——连接器开发、管理
1.连接器工厂的介绍
连接器工厂是可以对连接器鉴权邮箱账号进行管理,需要注意的是只有应用管理员才可以在平台管理当中去看到连接器工厂的一个入口。分别来介绍一下连接器管理,是用于连接用户自定义的接口,鉴全管理,所有在连接器工厂当中创建的连接器都需要去建立对应的鉴权管理,也就是对应的请求鉴权方案邮箱账号管理,的邮箱账号管理是发件人的邮箱地址需要在此提前进行添加,否则集成&自动化当中的发送邮件节点会选择不到这个邮箱。当然在本章课程当中不会用到
2.创建连接器
接下来来创建一个连接器,复习一下第一小节讲到的创建连接器的步骤,在点击创建连接器,在右侧的弹窗当中去创建连接器,选择HTTP的这个自定连接器,然后输入自定义的连接器的名称,点击确定,创建完成后会进入到连接器工厂的基本配置页面。
3.连接器1工厂配置基本信息
先来了解一下的基本信息,首先是 host 是请求的 host 地址,不需要带上 HTTP 或者是 HTTPS 的协议头,同时也不需要以为结尾。是 BaseURL,可以去配置请求的地址的基本前缀 URL,没有的话可以去直接填写,是 Schema 是一个协议类型,刚才在上方的 Host 里面不需要带这样的协议头,可以直接在去进行配准,支持 https和 http,是连接器的显示名称可以去自定义这样的一个名称,然后可以去定义连接器的基本 icon,也就是一个图标。
是连接器的一个介绍,可以去书写是一个什么样的一个连接器。基本信息配置完成后会下一步配置安全验证信息。
4.连接器工厂配置安全验证信息
来看一下连接器配置安全信息,是有5种,分别为无身份验证、基本身份验证,API秘钥,阿里云 API 网关还有钉钉开放平台验证,依次来看一下这几种身份验证类型。
第一种无身份验证,也就是接口,是一些公开的接口,无需任何验证,可以直接去进行调用。
第二种基本身份验证,是只需要配置账号密码这个提示标签,用于提示使用者在注册鉴权信息,知道填写什么样的一个内容, 是 API 的鉴权方式,长期有效。访问者可以在待访问的系统当中去创建生成秘钥,开发者可以直接通过此屏障去调用支持此类鉴权的公开 API。
参数标签适用于配置鉴权信息时的提示
名称是需要的 APIkey 名称
参数位置可以把建成的信息附加在查询参数或者是 Header 里,根据请求系统需要去进行选择。
第四种身份验证类型是阿里云 API 网关,在选择了身份验证类型为阿里云 API 网关,那么在创建完成之后添加鉴权模板时,模板填写 APP Code 后,可以调用对应的阿里云 API。
最后一个是钉钉开放平台验证,选择了钉钉开放平台验证之后,创建完成连接器添加鉴权模板时,在模板填写处就是要填写 APP key 和 APP sectet,填写完成后就可以调用今天开放平台的 API。
在添加鉴权模板后,宜搭会通过鉴权自动生成鉴权的参数,再次看在请求时添加到 Header 参数当中,就无需用户再次去进行生成,这也是使用自定连接器去调用钉钉开放平台的优势。现在就了解了安全信息认证。
5.连接器工厂配置功能操作定义
首先是要去配置的一个基本信息,面包括唯一标识,用来识别不同的操作,
名称给操作命名,可以去起一个中文那上面的唯一标识是一个英文的。 然后是一个概述,的概述是内容的一个描述可以去写也可以不写因为是一个选填。
是的一个 request 请求,包括请求方式是什么样的一个请求方式,在这边就选择这样的一个方式,
然后 URL 是一个请求的一个 API 接,就是的一个 URL 的一个完整的 API 接去进行一个填写。
还有这个 path,如果在这个 API 接内以这种大括号的一个形式去书写了这样的一个 path 的变量,比如说 path 作为这个变量,那么这个path 就会自动的出现这个 pathparam 填写就会自动去出现。然后呢是的 Query,Query 是一般是接口的这个请求方式为 GET 的时候,代表请求的一个参数通常是指这个问号后面附加的这个参数,可以点击加号去进行一个新增。
那还有这个 Headers,Headers 是 Header 中需要的参数,目前是静态去配置的,可以去新增一项去进行一个配置。 那然后就是这个 Body 这个 Body 其实是在这边要去选择到 POST、DELETE 等等这种请求方式,那就可以去出现这个 Body 的这一个字段,那其实和 Response Body 其实长得是差不多的,那就是出现了之后,可以将的这个请求的参数以 JSON 的格式去填写到后续出现的这个 body 字段当中,然后去点击解析,然后用作后续在的连接器当中进行一个填写,
然后是 Response Body,作用是当连接器下游的这个数据节点,交易通知等需要引用返回的数据的时候,就可以贴入接口返回的一个事例数据贴到里面,然后去点击解析去进行一个解析,那也是只支持这个 JSON 对象的一个格式,那这就是连接器管理的整体配置路径。
6.连接器工厂鉴权配置
首先可以新建一个鉴权,在鉴权管理当中点击新建鉴权,需要注意的是所有的自定连接器都需要建立对应的请求.鉴权方案即便是无身份验证也需要去进行创建。
创建好鉴权之后,会弹出一个鉴权管理,在面去选择需要配置鉴权的一个连接器,的截图是使用到的身份验证为 API 密钥,所以需要填写 API 密钥,填写完成之后点击创建,这样的鉴权模板也配置完成了,就可以在连接器工厂测试刚创建好的自定连接器。
进入到的连接器工厂当中,找到刚创建的一个连接器,在出现一个测试按钮,点击测试,然后进入到的界面当中,可以去选择鉴权的模板。当然如果没有鉴权模板的话,也可以去点击添加鉴权模板,跳转到鉴权模板一面去进行添加。然后在下方的操作列表当中,可以去选择想要测试的一个接口,
现在去选择正确模板之后去配置测试的参数,在里面输入一些参数,输入完成之后点击测试操作,下方就会出现预期的一个结果,如果预期结果返回的是正确的话,那么就说明的配置是成功的。
7.实操演练
来进行实操演练,进行连接器工厂的实操演练,使用到的是的资产管理系统的这个第三方接口,作为连接器工厂的开发实践。
首先进入到的平台管理,然后选择到连接器工厂,在的连接器工厂是需要管理员权限才可以在这边去看到的,所以说没有连接器工厂的话,说明是没有管理员权限的,需要管理员开通一下
进入到的连接器工厂页面,在可以看到连接器管理,鉴权管理,邮箱账号管理。在先讲解一下连接器管理,进入到连接器管理之后去创建一个连接器,选择 http 自定义连接器,然后去给连接器名称命名,然后点击确定,这样就进入到了的基本信息配置。那面可以看到有 host,scheme 还有 Base URL 等等。那的 host 其实是域名的意思,一般对接外部系统都是用域名,然后是协议,协议比较安全的是https当然也支持 http,bast 是类似于域的概念,bast 和 host 的一个关系就是 host 是主域名bast 是如果域名下有多个功能,或者说域名有多个客户在用,希望不同的客户连接器完全分开,就可能会用到 bast URL 的功能。一般外部比较简单的 API 是不需要进行填写的,直接填写斜杠就可以了。
那在面是以资产管理系统这个系统的接口作为一个实践,所以将这个 API 文档打开,就是的一个第三方系统的接口以及的一个参数和请求类型的一个文档,那首先将 HOST 复制过来,然后是的一个协议类型,是一个 HTTP 类型,之后是 Base URL配置完成之后,还可以去上传的图标和连接器的一个介绍可以进行一个书写。那这边就不是必填的就去进行书写了。
点击下一步进入到的安全,是可以配置身份验证类型的,最简单的一种情况就是无身份验证,这种外部 API 是没有任何身份验证的,也就是说肯定是没有鉴权的。那这种其实在互联网上有,但是不多,因为存在安全风险,
然后是基本身份验证,这种 API 接口也有一些,面的验证是通过在 header 里面去放置一个用户名密码的这种方式进行验证。’那本次使用的连接器是使用的 API 密钥这种身份验证类型,
这个相当于每次外部 API 请求时,在某个位置会指定一个 taken 这边还是一个静态的 taken,在这边可以去指定的,有的是放到的查询参数里面,有的是放到header里面,这个其实在 API 手册当中都会有到讲解,那当前的这个连接性鉴权,就是API 密钥,会在每个访问的时候会把 header 里面去放入 taken。那当前的这个连接器鉴权是 API 密钥,会在每个访问的时候在 header 的里面去放入 taken,后面有这个阿里云 API 网关和钉钉开放平台验证可以去了解一下。
然后下一步配置完基本信息和安全之后,就开始定义连接器整个操作。这个资产管理的连接器主要分为两个操作,一个是入库,一个是出库,那在这边新增两个操作。
然后首先来看一下,第一个是入库,面的唯一标识一般是来调用了一个接口,作为一个唯一的标志,在这边书写一下,一般是一个英文的状态,然后的名称一般是资产入库接口,request 也就是请求,这些一般是来源于 API 手册上的内容,包括整个完全的URL,还有的请求方法是 post 还是 get,那打开准备好的文档,可以看到的一个请求类型和一个完整的 url,将url 复制过来。然后请求类型是 post 之后会出现一个 body,再看一下点击 get 的时候是没有这个 body 的,然后在 body 里面去书写入参,同样的打开的手册,将入参复制过来,然后去解析 body,配置连接器时以解析后的字段为准,可以去在选择的一个字段类型,显示名称是否必填,隐藏,默认值等等。先不去进行这样的一个书写,
继续配置的第二个,第二个操作是的一个资产出库,同样的取名,然后去定义一个请求,同样的是 post,然后复制一下的入参,在 body 里面粘贴,然后解析,没有去书写的一个 url 会进行报错,粘贴过来,然后点击保存,确定。进入到的这个测试页面,测试页面可以看到首先让去选择的鉴权,可以去选择的鉴权模板,如果说没有鉴权模板的话,还可以点击添加鉴权模板,直接跳转到的鉴权管理页面,去进行添加,点击添加,然后直接去进行一个书写。
API 秘钥进行书写,点击确定,进行测试的操作,没有书写任何值会进行报错,需要输入具体的值进行测试,这就是连接器工厂的一个开发和管理。