上班族 REST API

1.简介

上班族自动化平台带有REST API，允许任何第三方系统在平台上运行自动化流程并检索结果。 REST API使得将自动化流作为任何CI / CD管道的一部分变得容易。

REST API托管在LEAPWORK上 控制器， 如本文档后面所述。 REST API在默认端口上公开其端点 9001，但是可以根据需要手动配置端口。

REST API还包括一个API资源管理器，可以在浏览器中的以下URL上进行访问：

http：// {controllerMachine}：{controllerPort} / help / index＃

这样，您可以在设置实际集成之前轻松测试API中的端点并探索结果。

可以在LEAPWORK上访问该API 控制者 在下面的基本URL中。

请注意，当前版本（v4）和先前版本（v3）有一个基本URL。版本在基本URL中指示。

API v3将在6个月后折旧，因此我们建议您使用v4。

API v4-基本网址：

要么

API v3-基本网址：

例：

在这里阅读更多

为了限制对API的未经授权的访问，需要访问密钥才能访问任何端点。访问密钥应视为机密，因此请谨慎分享。

如下所述，访问密钥是在对API的任何请求中创建，维护和使用的。

只有 管理员 角色具有管理API访问密钥的特权。

要创建新的API访问密钥，请执行以下步骤：

在LEAPWORK中 工作室，点击 设定值 in the main menu.
选择 API访问密钥 然后点击 新增金钥 按钮。
在里面 添加访问密钥 菜单中，点击 产生金钥 按钮，以生成新的访问密钥。访问密钥是一个16个字符的文本字符串，例如， Mo87Nc4qDAtzJNDb。
添加注释以使访问密钥管理更易于理解。例如， 从CI / CD管道集成
按加 button.

现在可以在 访问密钥 列列表。

要分配访问密钥，请在列表中选择访问密钥，然后按复制。这会将访问密钥复制到剪贴板，以便轻松插入电子邮件，聊天等。

为了获得最佳实践，请为每个系统生成一个单独的访问密钥以使用API。这将允许更好的调试，因为通过API触发的所有操作都将包含系统访问API所使用的访问密钥，该密钥将显示在LEAPWORK审核日志中。

这也使管理员可以阻止/删除特定的访问密钥，从而防止从特定来源进行访问，而不会影响使用该API的其他系统。

有效的访问密钥必须是对API的所有请求的一部分。

访问密钥应添加为标题字段命名 快捷键 其值包含有效的访问密钥。

例：

快捷键: Mo87Nc4qDAtzJNDb

如果访问密钥被省略或无效，则端点将返回 401 –未经授权 message.