阅读和查看 Automation Anywhere 文档

Automation Anywhere Automation 360

关闭内容

内容

打开内容

REST Web Service package

  • 已更新:12/01/2020
    • Automation 360 v.x
    • 版本
    • RPA 工作区

REST Web Service package

使用 REST Web Service package 中的 actions 作为方法(DELETE、GET、PATCH、POST 或 PUT)向 API 发送请求和从 API 接收响应。

使用 REST Web Service actions

提供以下信息以发送 REST 请求并接收响应。并非所有参数都是所有方法必需的。
  • URI:API 资源的唯一地址。
  • 身份验证类型:有三种支持的身份验证模式:
    • 基本:文本字符串可用于基本身份验证。
    • 已登录 AD 用户:授权访问相关 API 的 Active Directory (AD) 用户通过 AD 进行身份验证。请求中不需要凭据。
    • Windows NT LAN Manager (NTLM) 验证(AD 用户):一种质询/响应验证方法,使客户端能够将其用户名和密码作为加密凭据或纯文本提供。我们建议您使用存储在 Automation Anywhere Credential Vault 中的凭据。
  • 标头:并非所有方法都需要标题。标题表示与请求关联的元数据。
    注: 要在请求中使用 API 密钥,请在标题名称字段中输入 api_key,并在字段中输入密钥值。
  • 捕获故障响应:选择该复选框以捕获失败响应(成功/正常响应除外)。在响应正文中捕获失败响应详细信息。
  • 内容类型:当标题包含内容类型时,它定义客户端和服务器之间的内容协商。REST Web Service actions 支持以下内容类型:
    • application/json
    • application/xml
    • text/plain
    • text/html
    • 文本/xml
  • 输出变量:响应输出被捕获在字典变量中。字典变量是键值对。使用响应标题名称作为密钥返回标题值,或将“Body”作为密钥返回响应正文。
    注: 响应密钥及其值在字典变量中可用,以显示 REST API 的响应状态。
    要获取 API 资源的标题名称列表,请执行以下步骤:
    1. REST Web Service action 之后插入 Loop action
    2. 选择对于字典中的每个键迭代器。
    3. 字典变量字段中,选择包含 REST Web Service action 输出的变量。
    4. 将每个键的值分配给 $prompt-assignment$
    5. 插入 Log To File action
    6. 提供文本文件的文件路径以保存标题名称列表。
    7. 将文本输入日志字段中插入 $prompt-assignment$
    8. 选择覆盖现有文件选项。
    9. 单击保存

      运行 bot 时,会将标题名称从 API 资源打印到选定的文件。

安全地传递值

您可以通过在以下支持的 action 字段中指定 locker、凭据和属性,将值从 Credential Vault 安全地传递到 Web 服务:
  • URI
  • 自定义标头
  • 正文:对于 application/x-www-form-urlencoded 内容类型,单击添加参数以从 Credential Vault 中选择值。

    对于所有其他内容类型,请选择选择凭据作为参数选项,然后单击选择

REST Web Service package 中的 Actions

Action 描述
DELETE 方法 删除由 URI 标识的资源。
GET 方法 检索由 URI 中包含的参数标识的信息。GET 方法没有内容类型,因为所有参数作为 URI 的一部分传递。

GET 方法的局限性和特征包括以下内容:

  • URI 长度限制为 2048 个字符。
  • 所有参数均在 URI 中传递。
  • GET 方法暴露 URI 中的数据,使其相比 POST 方法不安全。
  • GET 不会更改任何数据,使其对所有用户(无论授权如何)都很安全。
补丁方法 修改由 URI 标识的资源。
POST 方法 在 URI 中创建新资源。
  • 参数在请求正文中传递。
  • 请求正文没有长度限制。
PUT 方法 根据 URI 或正文中传递的参数更新或替换资源。

代理支持

如果您的设备配置了代理,则来自此 package 的所有出站请求将通过代理服务器路由。请参阅 使用代理将 Bot agent 连接到设备

发送反馈