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


















