Clicky

CLI和Local API

Updated 2/10/20 by Annes

Multilogin支持命令行界面（CLI）命令和Local API。本篇说明将介绍基础的CLI命令和Local API端点，并提供使用范例。

开始使用Local API的三个步骤：

1. 预定义软件的监听端口

2. 手动或通过CLI启动Multilogin软件

3. 使用Local API端点

1. 分配Multilogin端口

您需要预先定义软件端口，以使用Local API端点。下面是预定义Multilogin端口的方式：

  1. 前往C:\Users\%username%\.multiloginapp.com 路径并打开app.properies文件
  2. 在文件中添加这个语句：multiloginapp.port=[PORT_NUMBER]
  3. 保存app.properties文件

随后，您可以通过此端口引用Multilogin程序。

2. CLI

在命令提示符中输入以下命令之前，请确保您在Multilogin主目录（在Windows设备中，通常为"C:\Program Files (x86)\Multilogin"）中打开了您的CMD或Terminal。
如果您使用的是UNIX系统，请确保您给.sh文件添加了执行许可。您可以通过“chmod +x 命令”（如“chmod +x multilogin.sh”）来给一个文件添加执行许可。
在任意端口开启带有用户界面的Multilogin： 

Windows

multilogin.exe

Linux/MacOS

./multilogin.sh
在预定义端口（以45000为例）开启不带用户界面的Multilogin：

Windows

headless.exe -port 45000

Linux/MacOS

./headless.sh -port 45000

Please keep in mind that although our app can be launched in headless mode, the browser profiles can not. You still need to have a system with a graphical user interface in order to use them.
登入Multilogin账户：

Windows

cli.exe -login -u user@example.com -p password123

Linux/MacOS

./cli.sh -login -u user@example.com -p password123

3. Local API

Local API端点能在5.4及更高版本的Multilogin中被使用。

当您手动或通过CLI开启Multilogin后，便可使用Local API端点。Local API提供了一个程序化的方式，来读写Multilogin浏览器配置文件的数据，例如：新建一个浏览器配置文件、获取全部浏览器配置文件的列表、将一个浏览器配置文件分配到一个小组，等等。

Local API端点

您可以从我们的Swagger 文档（OpenAPI Specification）中获取Local API端点。

测试我们的示范代码

以下代码示范了如何开启已存在的Multilogin浏览器配置文件，并执行简单的Selenium或Puppeteer浏览器自动化：

方案限制

仅Automate和Scale方案的用户有权使用Local API，每秒可发送的API请求数也有一定的限制。

如果您从一个不包含Local API功能的账号发送API请求，服务器将发出以下报错：

{"status":"ERROR","value":"unauthorized"}
速率限制

所有付费方案都有速率限制。根据端点类型，有两类限制：

  • 返回一个列表的请求（例如：listProfiles）：1个请求/分钟。
  • 所有其他请求：10个请求/分钟。

一旦达到限制后，服务器将回应如下报错信息：

{"status":"ERROR","value":"rate limit exceeded."}

如果您收到API返回的报错信息：“6-second timeout”，那么此时有效的API请求也会被系统拒绝。

请联系我们的客户支持团队，以了解更多详细信息。

How did we do?