# Локальный API

API MoreLogin предлагает комплексный и удобный для разработчиков RESTful-интерфейс, позволяющий программно управлять профилями браузеров, облачными телефонами и связанными ресурсами. Локальный API MoreLogin работает на вашем компьютере и доступен по адресу: 127.0.0.1:40000

Version: 1.0.0

## Servers

Local API
```
http://127.0.0.1:40000
```

## Download OpenAPI description

[Локальный API](https://guide.morelogin.com/_bundle/@l10n/ru/API%20Reference/Browser/local-api.yaml)

## Profiles

### Быстрое создание профиля браузера

 - [POST /api/env/create/quick](https://guide.morelogin.com/ru/api-reference/browser/local-api/profiles/paths/~1api~1env~1create~1quick/post.md)

### Расширенные настройки создания профиля браузера

 - [POST /api/env/create/advanced](https://guide.morelogin.com/ru/api-reference/browser/local-api/profiles/paths/~1api~1env~1create~1advanced/post.md)

### Изменить профиль браузера

 - [POST /api/env/update](https://guide.morelogin.com/ru/api-reference/browser/local-api/profiles/paths/~1api~1env~1update/post.md)

### Удалить профиль браузера

 - [POST /api/env/removeToRecycleBin/batch](https://guide.morelogin.com/ru/api-reference/browser/local-api/profiles/batchdeletebrowserprofilesusingpost.md)

### Получите список профилей браузера

 - [POST /api/env/page](https://guide.morelogin.com/ru/api-reference/browser/local-api/profiles/listbrowserprofilesusingpost.md)

### Получить сведения о профиле браузера

 - [POST /api/env/detail](https://guide.morelogin.com/ru/api-reference/browser/local-api/profiles/getbrowserprofiledetailsusingpost.md)

### Получить статус блокировки безопасности браузера

 - [POST /api/env/lock/query](https://guide.morelogin.com/ru/api-reference/browser/local-api/profiles/querybrowserlockstatususingpost.md)

### Группа пакетного изменения профилей

 - [POST /api/env/setGroup/batch](https://guide.morelogin.com/ru/api-reference/browser/local-api/profiles/paths/~1api~1env~1setgroup~1batch/post.md): Используется для пакетного изменения информации о группах профилей. Создает новую группу, если группа с таким именем не существует.

### Пакетное изменение профилей через прокси

 - [POST /api/env/setProxy/batch](https://guide.morelogin.com/ru/api-reference/browser/local-api/profiles/paths/~1api~1env~1setproxy~1batch/post.md)

### Примечание к пакетному изменению профиля

 - [POST /api/env/setRemark/batch](https://guide.morelogin.com/ru/api-reference/browser/local-api/profiles/paths/~1api~1env~1setremark~1batch/post.md)

## Runtime

### Запустить профиль браузера

 - [POST /api/env/start](https://guide.morelogin.com/ru/api-reference/browser/local-api/runtime/startbrowserprofileusingpost.md): Используется для запуска профиля; необходимо указать идентификатор профиля. После
успешного запуска вы можете получить отладочный интерфейс профиля для
выполнения автоматизации Selenium и Puppeteer. Для Selenium используйте
WebDriver, соответствующий версии ядра. Путь к WebDriver
можно получить из ответа после запуска профиля. Требуется
клиент MoreLogin версии 2.15.0 или выше.

### Остановить профиль браузера

 - [POST /api/env/close](https://guide.morelogin.com/ru/api-reference/browser/local-api/runtime/paths/~1api~1env~1close/post.md): Закрывает указанную среду. Требуется указать идентификатор среды. Требуется приложение MoreLogin версии 2.15.0 или выше.

### Получить информацию о состоянии работы профиля браузера

 - [POST /api/env/status](https://guide.morelogin.com/ru/api-reference/browser/local-api/runtime/paths/~1api~1env~1status/post.md)

### Закройте все открытые профили.

 - [POST /api/env/closeAll](https://guide.morelogin.com/ru/api-reference/browser/local-api/runtime/paths/~1api~1env~1closeall/post.md): Закрывает все открытые окна профиля. Параметры запроса не требуются.

### Получить идентификаторы процессов всех открытых профилей

 - [POST /api/env/getAllProcessIds](https://guide.morelogin.com/ru/api-reference/browser/local-api/runtime/paths/~1api~1env~1getallprocessids/post.md): Получает идентификаторы процессов всех открытых профилей. Параметры запроса не требуются. Требуется приложение MoreLogin версии 2.49.0 или выше.

### Получить информацию для удаленной отладки для всех открытых профилей.

 - [POST /api/env/getAllDebugInfo](https://guide.morelogin.com/ru/api-reference/browser/local-api/runtime/paths/~1api~1env~1getalldebuginfo/post.md): Получает информацию о порте удаленной отладки и другие данные для всех открытых профилей. Параметры запроса не требуются.

### Скачать ядро браузера

 - [POST /api/env/core/download](https://guide.morelogin.com/ru/api-reference/browser/local-api/runtime/paths/~1api~1env~1core~1download/post.md): Скачать и установить ядро(а) браузера. Поддерживает пакетную загрузку до 20 ядер за один запрос. Тайм-аут для этой операции может составлять до 30 минут; вызывающей стороне рекомендуется установить тайм-аут более 1805 секунд.\n\nТребуется версия клиента MoreLogin 2.61.1 или выше.\n\n### Обработка дублирующихся запросов\n\n- Если один и тот же тип браузера и основная версия встречаются несколько раз в одном запросе, поиск и загрузка выполняются только один раз, но каждая запись получает свой собственный результат.\n- Параллельные запросы для той же версии присоединятся к текущей задаче вместо начала новой загрузки.\n- Если запрошенная версия уже установлена с последней минорной версией, статус будет already_installed.\n- Если установлена старая минорная версия, она будет обновлена до последней доступной минорной версии.\n\n### Справочник кодов ошибок\n\n| errorCode | Описание |\n|---|---|\n| INVALID_JSON | Некорректный формат JSON |\n| INVALID_REQUEST | Некорректная структура запроса |\n| BATCH_LIMIT_EXCEEDED | Массив Cores превышает 20 элементов |\n| UNSUPPORTED_BROWSER_TYPE | Неподдерживаемый тип браузера |\n| INVALID_VERSION | Некорректный формат версии |\n| METADATA_LOOKUP_FAILED | Не удалось запросить метаданные ядра |\n| UNSUPPORTED_VERSION | Версия ядра не существует или не поддерживается на этой платформе |\n| CLIENT_NOT_READY | Клиент не готов |\n| SDK_NOT_READY | SDK не инициализирован |\n| INSUFFICIENT_DISK_SPACE | Недостаточно дискового пространства |\n| DOWNLOAD_FAILED | Загрузка не удалась |\n| CHECKSUM_MISMATCH | Проверка контрольной суммы MD5 не пройдена |\n| EXTRACTION_FAILED | Извлечение или установка не удалась |\n| TIMEOUT | Тайм-аут операции |\n| UNKNOWN | Неизвестная ошибка |

## Fingerprint & Device Config

### Получить список версий ядра браузера

 - [GET /api/env/advanced/ua/versions](https://guide.morelogin.com/ru/api-reference/browser/local-api/fingerprint-and-device-config/paths/~1api~1env~1advanced~1ua~1versions/get.md)

### Получить профиль пользователя браузера

 - [POST /api/env/advanced/ua/get](https://guide.morelogin.com/ru/api-reference/browser/local-api/fingerprint-and-device-config/getbrowserprofileuausingpost.md)

### Получить разрешение

 - [POST /api/env/base/resolution/list](https://guide.morelogin.com/ru/api-reference/browser/local-api/fingerprint-and-device-config/listresolutionsusingpost.md)

### Получите настраиваемые платформы

 - [GET /api/system/platform/list](https://guide.morelogin.com/ru/api-reference/browser/local-api/fingerprint-and-device-config/paths/~1api~1system~1platform~1list/get.md)

### Получите список часовых поясов и языков.

 - [POST /api/env/base/list](https://guide.morelogin.com/ru/api-reference/browser/local-api/fingerprint-and-device-config/listtimezoneandlanguageusingpost.md)

### Обновить отпечаток пальца

 - [POST /api/env/fingerprint/refresh](https://guide.morelogin.com/ru/api-reference/browser/local-api/fingerprint-and-device-config/refreshfingerprintusingpost.md)

### Получить список моделей телефонов

 - [POST /api/env/base/mobile/devices](https://guide.morelogin.com/ru/api-reference/browser/local-api/fingerprint-and-device-config/paths/~1api~1env~1base~1mobile~1devices/post.md)

## Cache & Window

### Очистить локальный кэш профиля

 - [POST /api/env/removeLocalCache](https://guide.morelogin.com/ru/api-reference/browser/local-api/cache-and-window/clearlocalprofilecacheusingpost.md)

### Облачный кэш для чистой среды

 - [POST /api/env/cache/cleanCloud](https://guide.morelogin.com/ru/api-reference/browser/local-api/cache-and-window/paths/~1api~1env~1cache~1cleancloud/post.md): Очищает облачные файлы cookie и другие данные среды (LocalStorage, IndexedDB, расширения и их данные).

### Получить список экранов

 - [POST /api/env/getAllScreen](https://guide.morelogin.com/ru/api-reference/browser/local-api/cache-and-window/paths/~1api~1env~1getallscreen/post.md): Используется для получения информации обо всех мониторах. Параметры запроса не требуются.

### Адаптивное расположение окон одним щелчком мыши

 - [POST /api/env/arrangeWindows](https://guide.morelogin.com/ru/api-reference/browser/local-api/cache-and-window/paths/~1api~1env~1arrangewindows/post.md): Используется для упорядочивания открытых профилей одним щелчком мыши. Требуется, чтобы был открыт хотя бы один профиль.

