跳到主要内容

发送API请求

1. 简介

1.1 功能简介

用于调用外部系统的 API 接口

1.2 使用场景

  1. 获取外部系统的数据
  2. 向外部系统推送数据

2. 使用步骤

2.1 配置

  1. 添加节点

  2. 选择请求方法,可选的有 GET、POST、PUT、DELETE、HEAD、PATCH,一般情况都是使用 GET 或 POST 请求,具体需要看所调用的 API 的情况。

  3. 配置请求地址(url):api 的调用链接,可以在后面拼接参数

  4. Header 配置:有的系统需要将授权信息等参数配置在 Header 中

  5. Body 配置:用于传输入请求参数,只有 POST、PUT、PATCH 请求需要配置。支持 form-data、x-www-form-urlencoded、 text、json 和 binary 四种方式。

    以 binary 方式发送附件时,以二级制数据输出,只能选择 1 个附件。

  6. 请求成功状态码,一般为 200

  7. 请求错误的状态码及错误消息:用于识别请求失败时的错误信息

2.2 测试 API

以上接口信息配置完毕后,就可以测试是否能正常请求了,点击【测试 API】按钮

如果请求 URL 中的参数使用了节点动态值,在第一次点击测试时,会让您填写参数的测试数据,您填写后可以将测试值替换动态参数后发起请求

调用成功后可以在下方响应 Body 查看接口返回的信息

2.3 使用 API 请求

需要在后续节点中使用 JSON 解析节点,将 API 请求获取的信息解析成其它节点能够识别的字段,再在后面的新增、更新等数据处理节点中使用。 (详情请查看 JSON 解析节点)