UiPath Documentation
maestro-automate
latest
false
Maestro Automate 用户指南

调用外部 API

逐步构建一个工作流,该工作流会使用“HTTP 请求”调用 API,然后使用“转换”和“脚本”调整响应。

您构建的内容​

此工作流调用经过身份验证的表述性状态传输 (REST) API,处理响应,并将提取的数据提供给之后的节点。REST API 是一项网页服务,其他软件可以通过 HTTP 调用。该模式适用于公开 HTTP API 的任何系统。

开始之前​

  • 目标 API 的基本 URL、端点路径和身份验证详细信息(API 密钥、持有者令牌或基本身份验证凭据)。

使用的节点​

步骤​

提示:

编码智能体设置后,您可以跳过手动步骤。询问:

Build a Maestro Automate workflow that starts manually with a userId, calls GET https://dummyjson.com/users/{userId} with an HTTP Request node, returns the user's name and email, and logs the error on the node's error path if the call fails.
Build a Maestro Automate workflow that starts manually with a userId, calls GET https://dummyjson.com/users/{userId} with an HTTP Request node, returns the user's name and email, and logs the error on the node's error path if the call fails.

然后在画布上打开工作流,根据以下步骤进行检查并进行测试。“设置编码智能体”描述了相关设置。

1. 新建工作流并添加触发器​

按照您的第一个工作流所述创建项目。画布将打开,画布上已有“手动触发器” 。

2. 添加并配置“HTTP 请求”节点​

  1. 选择手动触发器输出柄上的“+”号,搜索“HTTP 请求” ,然后选择该请求。
  2. 在“属性”面板中:
    • 将“方法”设置为适当的动词( GET 、 POST 、 PUT 、 PATCH或DELETE )。
    • 输入端点的完整URL 。
    • 在“标头”下,添加身份验证和“内容类型”标头。

对于持有者令牌身份验证:

添加一个名为Authorization且值为Bearer {{ secret.apiKey }}的标头。secret.前缀从安全变量存储中读取值。系统不会将密钥直接粘贴到字段中。

对于基本身份验证:

添加一个键为Authorization且值为Basic {{ secret.encodedCredentials }}的标头,其中encodedCredentials是 Base64 编码的username:password字符串。

3. 提取所需数据​

  1. 选择“HTTP 请求”节点输出句柄上的“+”号,搜索“数据转换” ,然后将其选中。
  2. 在属性面板中,将$vars.httpRequest1.output.body中的所需响应字段映射到命名输出变量。

例如,要从{ "user": { "name": "Alex", "email": "alex@example.com" } }等响应中提取用户名和邮箱,请映射:

  • $vars.httpRequest1.output.body.user.name → userName
  • $vars.httpRequest1.output.body.user.email → userEmail

4. 添加错误处理​

  1. 选择“HTTP 请求”节点,打开“错误处理”选项卡,然后开启“启用错误处理” 。主输出句柄下方显示“错误”句柄。
  2. 选择“错误”句柄上的“ +” ,搜索“脚本” ,然后选择它。
  3. 在“脚本”节点中,记录$vars.httpRequest1.error中的错误:
const error = $vars.httpRequest1.error;
console.log('API call failed:', error.message, '| Status:', error.status);
return null;
const error = $vars.httpRequest1.error;
console.log('API call failed:', error.message, '| Status:', error.status);
return null;

5. 测试和调试​

在画布底部工具栏中选择“运行调试”。在执行追踪中:

  • 检查 HTTP 请求节点的code输出。200表示成功; 401表示您的身份验证错误; 404表示 URL 不正确。
  • 检查数据转换节点的输出,以确认已正确提取字段。
  • 要测试错误路径,请暂时将 URL 设置为无效值,并验证错误路径是否执行。

结果​

工作流调用 REST API,从响应中提取字段,并在错误路径上记录失败。执行追踪记录显示 HTTP 状态代码和为两条路径提取的值。

扩展此工作流​

  • 处理分页:如果 API 返回的结果跨多个页面,则添加后续 HTTP 请求节点以获取其他页面,根据响应是否包含下一页光标进行分支决策。
  • 将结果写入另一个系统:在“数据转换”节点后,添加另一个“HTTP 请求”节点或集成节点,以将数据推送到下游。
  • 为其计划:将“手动触发器”替换为“计划触发器” ,以定期运行工作流。

后续步骤​

  • 部署工作流:让工作流在没有您的情况下运行。
  • 指南: 更多待构建的工作流。
  • 社区: 共享您构建的内容,或向其他构建器寻求帮助。

此页面有帮助吗?

连接

需要帮助? 支持(opens in new window)

想要了解详细内容? UiPath Academy(opens in new window)

有问题? UiPath 论坛(opens in new window)

保持更新