集简云教学 数据表教学 应用教学 开放平台 用户社区 语聚AI
打开导航
首页 > 开放平台 > 开放平台(上架应用) > 如何配置动作接口参数?
如何配置动作接口参数?
动作接口配置中设置如何使用动作中的字段请求您的接口

 

1 设置API接口请求

 

 

在这个设置中配置改动作的接口请求地址,和请求方式(post, get, put, patch, delete, head)

其中接口请求地址中可以插入动作配置中的字段key或者授权配置中的字段key作为变量参数,示例:

 

https://coda.io/apis/v1/docs/{{input_data.docId}}/tables/{{input_data.tableIdOrName}}/rows

 

变量格式

动作字段变量格式:{{input_data.xxx}}

授权字段变量格式:{{auth_data.xxx}}

其中xxx部分为您设置的字段Key

更多变量和使用方式见:

编译变量&使用方式

 

更多参数设置:

 

如果您需要配置额外的参数在body或者header,可以点击”更多选项

 

 

点击后展开更多选项,可以配置body,header等参数,

 

 

添加参数时左侧为字段key,右侧为字段key对应的字段值,字段值可以引入变量。您可以在右侧的下拉选项中设置这个字段的类型。

 

 

额外选项:点击“额外选项”按钮会展开如下选项配置:

 

 

 

请求字段为空时自动忽略的意思是指,如果接口配置设置的参数值为空时,自动忽略对应参数key的请求。例如,我们配置了一个参数,参数key为key1, 参数值为变量 ({{input_data.phone}}. 由于变量值有可能为空,比如用户没有在前端填写这个参数。因此:

如果请求求字段为空时自动忽略开启时,如果字段值为空,则请求时不会包括key1在请求中。

如果关闭此设置,如果字段值为空,则请求接口时会包括字段key1,但是字段值会为空,

 

编码模式

 

如果您需要更加复杂的请求方式,例如运行代码计算或者需求请求多个不同的接口完成请求,您可以使用编码模式,点击“切换至编码模式“按钮

 

 

进入编码模式:

 

 

更多编码模式介绍见相关文档:

编码模式说明

 

2 接口请求测试

 

接口请求测试将使用实际的接口授权(在应用授权配置中添加的账户)和您配置在动作的请求参数(在动作设置中添加的字段key)进行接口调用,以检验接口是否可用。

 

 

在账户列表中选择一个已经授权的账户,如果没有选择添加新账户。添加新账户时需要填写的字段和请求接口都是您在应用授权步骤设置的。

 

 

选择账户后添加测试数据,点击”执行动作测试”按钮发送数据,验证接口是否可以正常使用。

 

 

接口返回:展现接口返回内容:

 

HTTP: 展现请求时的Header,Body等参数:

 

 

3 设置样本数据

 

样本数据不是必要步骤,当时我们非常建议配置,其作用是将返回的参数转换为中文,以便用户使用:

 

 

更多关于动作样本的设置见文档:

动作样本设置

https://www.jijyun.cn/help/detail/783

 

本篇目录
  • 1 设置API接口请求
  • 更多参数设置:
  • 编码模式
  • 2 接口请求测试
  • 3 设置样本数据