集简云教学 数据表教学 应用教学 开放平台 用户社区 语聚AI
打开导航
首页 > 开放平台 > 开放平台(上架应用) > 编码模式说明
编码模式说明
集简云可视化构建器在每个 API 请求上都包含一个切换到编码模式的开关,它将特定的 API 调用切换到编码模式。

编码模式说明

 

编码模式如何工作?

 

 

集简云 可视化构建器中的每个 API 配置块都包含一个编码模式切换开关。

集简云 可视化构建器包含一个表单,用于添加 API 请求地址(URL) 并选择 API 调用类型。您还可以设置您的 API 可能需要的任何自定义选项,包括自定义 URL 参数、HTTP 标头和请求正文项。集简云 然后将 JSON 编码的响应解析为单独的输出字段,以用于后续的流程步骤中。

这是在 集简云 集成身份验证、触发器和操作中设置大多数 API 调用和选项的最佳方式。

但是,如果您的 API 调用需要更多自定义,或者您的 API 响应是非 JSON 格式,您将需要编写自定义 Python 代码来处理您的 API 调用和/或响应解析。集简云 可视化构建器在每个 API 请求上都包含一个切换到编码模式的开关,类似于上图,它将特定的 API 调用切换到编码模式。

 

请记住:编码模式是一个切换。代码模式和表单模式分别保存;对一个的更改不会影响另一个。当前可见编辑器中的设置是 集简云 在您的集成中使用的设置

 

第一次切换到编码模式时,集简云 会复制在 API 请求表单中输入的所有内容,包括添加的任何自定义选项,并将它们转换为 Python 代码。然后它将 UI 更改为编码模式,您可以在其中为 API 调用添加代码。

每个身份验证、触发器和操作的时间限制为 30 秒,因此请保持您的自定义代码尽可能轻巧快捷。如果代码运行时间超过 30 秒,则会超时,用户的流程将不会成功。

请注意,更改不会自动保存。添加所需代码后,单击保存并继续或者使用快捷键(Ctrl+s)将更改添加到您的集成中。

 

 

切换到编码模式后,集简云 将使用您的自定义代码进行该 API 调用,而不使用您之前在表单中输入的数据。

如果您想切换回表单模式,请单击“切换至表单模式”按钮以查看您第一次切换到编码模式时的表单选项。集简云 将保存您输入的代码,但不会将其转换回表单模式或在您的实时集成中使用自定义代码。

您可以再次切换回编码模式(集简云 将显示您的代码的最后保存版本),并且不会将您的 API 调用表单中的任何更改复制到代码中。

下图展示的是编码模式默认生成的代码。

 

 

编码模式下,支持import引入python自带模块,不支持第三方模块安装。用户可以根据需要自行import需要的模块。

API 调用响应不同数据

 

用于身份验证、身份验证测试和创建操作的对象。集简云 期望接收具有正确详细信息的单个 JSON 格式对象,包括取决于身份验证方案的身份验证调用的特定字段。集简云 将解析各个字段,并通过 执行动作 让用户在随后的流程步骤中使用这些数据。

触发器的数组。集简云 期望收到一个 JSON 格式的数组,结果按时间倒序排列。即使触发器仅返回单个项目,也应将其格式化为数组。集简云 然后将解析结果并返回,并从通过 集简云 数据唯一标识 配置的字段进行去重操作

模版变量使用

认证字段:{{ auth_data.xxx }}

输入字段:{{ input_data.xxx }}

环境变量:{{ process.env.xxx }}

如果字段值为字符串类型,则应该在前后加上 '或者"。如 key = '{{ input_data.key }} '。非字符串类型(包括number、dict、list等不需要此操作)

存储临时数据

 

集简云提供存储临时数据功能。通过jjySave进行数据存储(临时存储的数据最多保留30天)。通过jjyLoad进行数据读取。

jjySave:

参数'secret': type=str,要求为UUID4格式;

参数'data': type=dict or list, 支持可序列化的json格式。

如:jjySave(secret, data)

jjyLoad:

读取临时数据。参数'secret':要求为UUID4格式,存储时传入的secret

本篇目录
  • 编码模式说明
  • 编码模式如何工作?
  • API 调用响应不同数据
  • 模版变量使用
  • 存储临时数据