CLI и Local API

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

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

1. Предопределите порт, который будет использовать приложение.
2. Запустите Indigo вручную или с использованием CLI.
3. Используйте эндпойнты Local API.

Определение порта indigo

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

1. Пройдите в директорию C:\Users\%username%\.indigobrowser и откройте файл app.properties в любом текстовом редакторе.
2. Добавьте следующую строку: multiloginapp.port=[PORT_NUMBER].
   
   Номер порта должен находиться в диапазоне от 10000 до 49151.
   
   
3. Сохраните файл app.properties.

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

Command Line Interface (CLI)

Прежде чем вводить последующие команды, пожалуйста уточните что командная строка открыта в основной директории Indigo.

Для Indigo версии 6.0 и выше

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

Для Indigo версии 5.19 и ниже

• Windows: C:\Program Files (x86)\Indigo
• macOS: /Applications/indigo.app/Contents/MacOS

Если вы работаете на UNIX системе, удостоверьтесь, что у .sh файла имеются права на запуск. Сделать это можно при помощи команды chmod +x (например, chmod +x headless.sh).

Запуск Indigo без UI

Windows

headless.exe

Linux/MacOS

./headless.sh

Запуск Indigo без UI на определённом порту (45000 используется в качестве примера)

Windows

headless.exe -port 45000

Linux/MacOS

./headless.sh -port 45000

Обратите внимание, несмотря на то, что приложение можно использовать в режиме headless, сами браузерные профили открываются в обычном виде (не headless). Для использования профилей понадобится ОС с графическим интерфейсом.

Вход в аккаунт Indigo:

Windows

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

Linux/MacOS

./cli.sh -login -u [email protected] -p password123

Local API

Эндпойнты Local API доступны в Indigo версии 5.4 и выше.

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

Эндпойнты Local API

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

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

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

• Пример кода для Selenium на Java и Python
• JavaScript (Node.js) пример для Puppeteer

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

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

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

 {"status":"ERROR","value":"unauthorized"}

Ограничения по количеству запросов

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

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

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

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

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