魔笔平台提供了强大的阿里云 OpenAPI 集成功能,允许用户通过简单的配置,实现对阿里云 OpenAPI 接口的无缝连接和数据交互。本文档将指导您如何创建和使用阿里云 OpenAPI 集成。
功能介绍
魔笔平台的阿里云 OpenAPI 集成功能支持以下特点:
自定义触发方式:集成操作可以设置为手动触发或自动运行,满足不同的业务场景需求。
回调和数据转换:支持在查询成功或失败时执行特定的集成操作事件,以及对返回的数据进行自定义处理。
高级设置:提供防抖和禁止执行条件的高级配置,以优化集成操作的执行。
事件相关内容可参考:集成操作事件
使用阿里云 OpenAPI 集成
步骤 1:创建阿里云 OpenAPI 集成
登录魔笔平台,进入管控台。
导航至“资源”->“集成”,点击“创建集成”。
选择“阿里云 OpenAPI”,并填写集成名称及描述。
配置不同环境的阿里云 OpenAPI 集成信息,包括
产品
、版本
、地域
和访问密钥
等。点击“确定”以创建阿里云 OpenAPI 集成。
步骤 2:在应用内部创建集成操作
打开“代码”面板,点击对应作用域的“+”后选中“集成操作”。
选择之前创建的阿里云 OpenAPI 集成作为资源,选择 API 后会展开该 API 下的所有参数,配置参数后点击运行以获取接口的返回结果。
点击“运行”预览查询效果。
配置面板详解
集成配置
产品:定义了预期发起阿里云 OpenAPI 请求的产品。
版本:定义了预期发起阿里云 OpenAPI 请求产品的版本。
地域:定义了预期发起阿里云 OpenAPI 请求的地域信息。
访问密钥:定义了预期发起 OpenAPI 请求所使用的访问密钥,关于访问密钥,可以参考创建AccessKey。
说明阿里云 OpenAPI 产品、版本和地域信息,可以参考阿里云 OpenAPI 开发者门户。
通用配置
参数:定义了查询所需的参数,包括类型、默认值和描述。在接口参数中,可通过
{{ varName }}
的方式引用参数。API:定义了预期调用的阿里云 OpenAPI 服务的产品接口。
protocol: 定义了预期调用的阿里云 OpenAPI 服务的协议。
method:定义了预期调用的 OpenAPI 服务的方法。
其他参数:根据所选择的 API 会自动生成该接口的参数配置项,用于传递该 API 需要的参数,必填参数会在该参数名后以红色星号标识。
回调配置
数据转化:对接口返回的数据进行处理,默认为
return data
,即不进行处理。成功回调:配置接口调用成功时触发的事件。
失败回调:配置接口调用失败时触发的事件。
高级配置
防抖:设置防抖表达式,避免接口的频繁调用。
禁止执行条件:根据条件表达式确定是否执行此集成操作。
手动触发集成
事件触发
在需要触发集成操作的组件中,配置事件处理器。
将动作类型设置为集成操作,并选择相应的集成。
以对象形式填写已配置的参数。
API 触发
若此集成操作的名称为action1
,则在任何可以执行脚本的地方,可以使用action1.trigger()
方法触发集成操作,若集成操作配置了参数,则需要以对象形式填写已配置的参数。