我的服务模式是什么?
所有 Suite: Team、Growth、Professional、Enterprise 或 Enterprise Plus
Support Team、Professional 或 Enterprise

使用整合生成器时,您可以在 API 请求正文中传递字符串、数字、布尔值和数组等类型的请求参数。此功能为 API 整合提供了更大的灵活性,并支持更广泛的用例。在本文中,我们将指导您完成配置这些参数的过程。

本文章包含以下主题:

  • 设置请求参数的参数类型
  • 添加数组参数的重新格式化
  • 在 API 调用请求正文中使用参数
  • 测试您的配置

相关文章:

  • 整合生成器资源

设置请求参数的参数类型

设置请求参数的参数类型

  1. 导航到整合生成器中的“请求参数”部分。
  2. 定义您的参数,并将其类型设置为以下之一:
    • 字符串:适用于用引号引起来的文本数据(例如,“example text”)。
    • 号码:用于数字值(例如 123)。
    • 布尔值:用于 true/false 值。
    • 数组:值的集合(例如,[“item1”, “item2”])。

添加数组参数的重新格式化

为了在整合生成器中测试数组类型参数,您必须添加一个重新格式化函数,以确保正确处理数据类型。为此,请使用以下函数:

$eval($)

此函数将字符串值解析为数组对象。

如果形参已经是数组对象,则函数不会改变其行为。

有关更多信息,请参阅重新格式化人工智能专员的请求参数中的值。

在 API 调用请求正文中使用参数

在 API 调用请求正文中,这些参数的使用格式与字符串参数相同,即使用以下语法:{{< REQUEST_parameter> }}

虽然该参数在正文中显示为字符串(如下面的屏幕截图所示),但在执行过程中,它将转换为“请求参数”部分中指定的相应数据类型。

测试您的配置

使用整合生成器中的测试正式版按钮执行 API 调用。

验证在请求中传递的参数是否为正确类型(字符串、数字、布尔值、数组)。

审阅响应以确保 API 进行正确处理。

注意:成功的转换取决于正确设置参数类型和重新格式化函数。配置错误可能导致 API 调用出错。

 

翻译免责声明:本文章使用自动翻译软件翻译,以便您了解基本内容。 我们已采取合理措施提供准确翻译,但不保证翻译准确性

如对翻译准确性有任何疑问,请以文章的英语版本为准。

由 Zendesk 提供技术支持