如何配置一个执行动作?
在这个教程中我如果在集简云开发者平台创建一个执行动作。
在集简云开发者们讲解平台配置一个执行动作有如下步骤:
动作信息设置: 配置动作的名称与描述等基本信息
动作字段设置:必要,用于展现字段列表,让用户在前端填写配置
动作接口参数设置:配置动作接口调用时需要的参数
我们有一篇示例文章讲解了执行动作的设置,可以参考:
1 动作信息设置
动作信息是用户在前端看到的动作名称与描述设置,示例:
动作信息设置包含以下几个模块:
动作名称:在前端展现给用户的动作名称,例如:当有新订单时,非必填,如果不填写则以字段key做为字段名称
动作Key:用于接口调用时的唯一字段标识,字段key应该为英文字母,例如API_Key,用户在前端不可见此字段
动作功能描述:描述此动作的功能,用户可以在前端看到此动作功能描述,示例:当有新增订单时同步数据并触发流程。
动作是否可见:选择用户是否可以在前端选择和使用此动作
2 动作字段设置
用于展现字段列表,让用户在前端填写配置
关于动作字段配置可以见文档:
如何设置动作字段?
在开发者平台有多个地方需要设置字段,本文章将详细说明如何设置字段。 什么是字段?它有什么用? 字段是用户要在前端填写的内容,可以在应用授权,设置触发/执行动作时都需要设置,字段在开发后台配置后,用户在使用时可在前端看到对应的字段。 例如:在
3 动作接口参数设置
3.1 设置API接口请求
点击动作配置中的 ”动作接口参数设置”标签,进入接口参数设置页面,在这个界面我们将配置调用接口时需要需要的参数。
例如:百度云OCR文档:https://cloud.baidu.com/doc/OCR/s/zk3h7xz52
我们设置请求地址和方式:
根据文档,我们设置请求方式为POST 请求地址为:https://aip.baidubce.com/rest/2.0/ocr/v1/general_basic
然后点击“更多选项”
会展开传入参数列表,在这里可以配置参数,header, body 等接口参数。
根据文档,在URL参数中需要输入 access_token,并使用接口授权中获取的参数。
我们在步骤 3.4 中请求参数返回中可以看到 返回内容中的token写在了”access_token” 这个字段内:
我们使用这个返回的字段key作为变量:
我们将文档中要求的参数:access_token写在请求参数中,后面插入授权变量,格式为 {{auth_data.授权接口返回内容中的字段key}}
步骤中授权接口返回的内容中包含token的字段key为 “access_token" 因此,我们这里写入的变量为:{{auth_data.access_token}}
更多关于变量的使用,请参考文档:
HTTP Header设置
配置完成 请求参数后,我们点击”HTTP Header"页签:
根据文档,我们添加header要求的内容:
Content-Type: application/x-www-form-urlencoded
请求Body设置
完成Header设置后,我们点击”请求body" 内容,根据文档,我们添加body请求内容:
前面为文档中要求请求的字段key,后面插入对应字段key中用户输入的变量,变量格式为:
{{input_data.动作字段设置中的字段key}}
额外选项
额外选项可以控制如果用户没有填写字段时,是否忽略此字段的传参,我们建议保持默认的开启状态。
开启状态下,如果用户没有填字段,则发送时会默认不传入这个字段到接口,如果不开启则会传空值。例如:
Key1, Key2两个字段,如果用户只填写了Key1,没有填写Key2。
开启状态下,只传Key1,不传Key2
关闭状态下,Key1和Key2都会传,未填写的Key2会传空值。
配置完成后点击“保存并继续”按钮
3.2 接口请求测试
在接口请求测试中,您可以测试接口是否可以正常请求并返回参数。
在账户选择栏选择账户,这里会调用我们在步骤3.3授权测试时添加的账户信息
填写要的请求参数,然后点击 ”执行动作测试“按钮, 点击后可以在”接口返回”中看到返回参数
在”HTTP"中可以看到请求发送的内容:
3.3 设置样本:
动作样本是让用户可以更简单的理解数据返回的参数是什么意思,由于集简云主要面向非技术人员,因此这个设置可以让用户更简单的使用您的应用。我们推荐您进行配置。
示例:下方是微信公众号配置样本后的示例:
通过样本数据设置可以将原本接口返回的参数转化为用户可以读懂的中文。
动作样本的配置方法:
进入您的动作配置,接口配置:
1 您可以写入一个json格式的数据样本
2 点击“生成输出字段按钮”,集简云会自动列出字段key转译表格
3 在第二列填写字段key对应的中文名称
4 字段描述:设置字段补充信息,比如:如果一个性别字段返回的字段值为0,您可以填写字段值说明,例如:0-未知,1-男,2-女,集简云将在前端展现此内容,帮助用户更好的使用您的应用: