Clicky

CLI и Local API

Обновлено 1/10/21 от Annes Silde

Статьи по теме

Multilogin поддерживает команды Command Line Interface (CLI) и Local API. Данное руководство представит основные команды CLI, эндпойнты Local API. Также, будут рассмотрены примеры использования CLI.

3 Шага для начала использования Local API:

1. Предопределите порт, который будет использовать приложение.

2. Запустите Multilogin вручную или с использованием CLI.

3. Используйте эндпойнты Local API.

1. Определение порта Multilogin

Для использования Local API необходимо предопределить порт. Вы можете сделать это следующим образом:

  1. Пройдите в директорию .multiloginapp.com и откройте файл app.properties (папка может быть скрытой, в зависимости от настроек вашей ОС):
  • Windows: C:\Users\%username%\.multiloginapp.com.
  • Mac OS: /Users/%username%/.multiloginapp.com.
Для отображения этой папки на устройства Mac можно использовать следующие комбинации клавиш:
- Cmd + Shift + H – для отображения папки текущего пользователя.
- Cmd + Shift + . (точка) - для отображения скрытых папок и файлов.
  • Linux: /home/%username%/.multiloginapp.com.
  1. Откройте файл app.properties в любом текстовом редакторе.
  2. Добавьте следующую строку: multiloginapp.port=[PORT_NUMBER].
  3. Сохраните файл app.properties

В дальнейшем вы можете обращаться к Multilogin используя выбранный вами порт.

2. CLI

Прежде чем вводить последующие команды, пожалуйста убедитесь, что командная строка открыта в основной директории Multilogin (в Windows это обычно ‘C:\Program Files (x86)\Multilogin’).
Если вы работаете на UNIX подобной системе удостоверьтесь, что у .sh файла имеются права на запуск. Добавить права на запуск можно при помощи команды chmod +x (например ‘chmod +x multilogin.sh’).
Запуск Multilogin с UI на случайном порту:

Windows

multilogin.exe

Linux/MacOS

./multilogin.sh
Запуск Multilogin без UI на определённом порту (45000 используется в качестве примера):

Windows

headless.exe -port 45000

Linux/MacOS

./headless.sh -port 45000

Обратите внимание, что несмотря на то, что приложение можно использовать в режиме headless, сами браузерные профили открываются в обычном виде (не 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 доступны в Multilogin версии 5.4 и выше

После того как вы запустили Multilogin вручную либо с помощью CLI, вы можете работать с эндпойнтами Local API. Local API предоставляет доступ к созданию и изменению браузерных профилей Multilogin c помощью кода, а также управлению ними. Помимо этого, доступны получение списка всех профилей, добавление профилей в группы, и другие действия.

Эндпойнты Local API

Эндпойнты Local API доступны в нашей Swagger документации (OpenAPI Specification).

Протестируйте наш пример кода

Примеры кода для запуска существующих браузерных профилей Multilogin и выполнения простой автоматизации Selenium и Puppeteer:

Типы подписок

Local API доступна только для пользователей с подписками Automate или Scale, и некоторые эндпойнты имеют ограничения на количество запросов в минуту.

Если пользователь пытается воспользоваться API на подписке, не предоставляющей доступ, сервер ответит следующей ошибкой:

{"status": "ERROR", "message": "Forbidden", "value": "Forbidden"}
Ограничения по количеству запросов

Ограничения применяются ко всем типам подписок. Они делятся на два типа:

  • Запросы возвращающие списки - 1 запрос в минуту
  • Все остальные запросы - 10 запросов в минуту

При достижении лимита, сервер будет отвечать на запрос со следующей ошибкой:

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

В случае, если API возвращает ошибку, включается 6-ти секундное ограничение, в течении которого любые запросы к API будут отклонены.

Для дополнительной информации, свяжитесь с нашей технической поддержкой.

Видео по теме
Наши новости, полезные статьи и советы вы найдете здесь

Была ли полезной эта статья?