外部API请求

点击复制

与任何API沟通并整合任何服务。


外部API请求允许你定义请求模板,然后从业务流程中触发对任何API的外发调用。有了它们,你可以将你的项目连接到任何第三方服务,即使在市场上还没有相应的模块存在。


定义

在你想连接的服务提供商的API文档中,查阅请求的结构规格。

  1. 要定义一个新的请求模板,进入侧边栏的 "商业逻辑 "标签(1),切换到 "外部API请求 "标签(2),并点击 "新的API请求"(3)。

2.2. 给新的请求一个名字,也可以选择一个描述。

3.3. 选择请求的HTTP方法和它的URL。

4.4. 通过输入参数名称(1)、类型(2),并点击 "添加参数"(3),定义URL参数、查询参数(仅适用于GET请求)、头信息和请求正文。

这些参数的实际值将在触发请求的业务流程的执行时被定义。

要了解URL和查询参数之间的区别,请阅读这里。不管是哪种标准,你想连接的服务提供商的API文档是关于如何建立请求的最佳信息来源。

你也可以通过输入样本JSON来自动填写请求头和正文,系统会自动创建所有必要的参数。

你不必在每个标签上添加新的参数。例如,有些请求可能根本不包含任何URL参数、头文件或正文。

如果你的请求包含对象(如汽车->颜色、尺寸等),你将不得不创建虚拟模型,以便以后在你的业务流程中处理这些对象。通过在参数类型选择器中选择 "模型",并引入你需要的子元素来实现。你可以根据需要多次嵌套对象(即对象中的对象)并创建虚拟模型数组。如果你使用了自动填充功能,这个过程就会自动完成。

5.改变请求的设置,如SSL验证、超时和 "设置 "标签中的错误处理。

6.通过点击 "测试请求 "并输入所有需要的参数来测试该请求。检查服务器的响应,自动填写响应头和正文,或者手动填写。

7.7. 通过点击 "保存请求 "来保存请求模板。

使用

在你定义并保存一个新的请求后,在业务流程编辑器中会有一个新的块来触发它。


你将不得不向它提供你想添加到请求中的所有组件(URL和查询参数,标题和正文)作为数据模型,可以使用这些块来制作。在输出中,你将能够提取格式化的响应主体、它的标头和响应状态。你可以使用这些块来扩展这些模型。

你不必为了请求的正确触发而连接所有的数据输入。例如,如果你有一个没有URL参数的请求,你不需要创建它的模型并连接它。

对于你定义的每一个虚拟模型,2个新的块将被添加到你的业务流程编辑器中,以制作和扩展它。


监测

每次你触发一个API请求,系统将向日志输出其类型和地址、请求主体、响应的HTTP状态代码和响应主体。你可以输出其他信息,如响应体的特定字段,或使用写到日志块向日志输出延时。