Clicky

CLI和Local API

Updated 4 weeks ago by Annes Silde

相关阅读

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

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

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

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


3. 使用Local API端点

1. 分配Multilogin端口

您需要预先定义软件端口,才能使用Local API端点。下面是预定义Multilogin端口的方式:

  1. 导航到\.multiloginapp.com文件夹,并找到app.properties文件(该文件可能会被隐藏在您的系统中)
    • Windows 用户:C:\Users\%username%\.multiloginapp.com
    • Mac 用户:/Users/%username%/.multiloginapp.com
    • Linux用户: /home/%username%/.multiloginapp.com
如果您用的是Mac设备,您可以前往Finder界面,同时按下Cmd + Shift + H键,打开“用户”文件夹,然后 ,同时按下Cmd + Shift + .(点号)键,显示隐藏文件夹。 之后,您便可以看到.multiloginapp.com/data文件夹。
  1. 在文件中添加这个语句:multiloginapp.port=[PORT_NUMBER]
端口号的范围为10000 ~ 49151
  1. 保存app.properties文件

随后,您可以通过此端口调用Multilogin程序。

2. CLI

在命令提示符中输入以下命令之前,请确保您已通过以下路径打开了CMD或Terminal。

Multilogin 6.0或更高版本:

  • Windows: C:\Program Files (x86)\Multilogin\headless
  • macOS: /Applications/multilogin.app/Contents/MacOS/multilogin.app/Contents/MacOS
  • Linux: /opt/Multilogin/headless

Multilogin 5.19或更低版本:

  • Windows: C:\Program Files (x86)\Multilogin
  • macOS: /Applications/multilogin.app/Contents/MacOS
如果您使用的是UNIX系统,请确保您给.sh文件添加了执行许可。您可以通过“chmod +x”命令(例如“chmod +x headless.sh”)来给一个文件添加执行许可。
通过headless模式启动Multilogin: 

Windows

headless.exe

Linux/MacOS

./headless.sh
在预定义端口(以35000为例)上,通过headless模式启动Multilogin:

Windows

headless.exe -port 35000

Linux/MacOS

./headless.sh -port 35000

请注意:Multilogin软件本身可以通过headless模式来运行,但是您无法通过此模式开启浏览器配置文件,您仍然需要在具有图形界面的系统环境下使用它们。
登入Multilogin账户:

Windows

cli.exe -login -u [email protected] -p password123

Linux/MacOS

./cli.sh -login -u [email protected] -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?