Postman — это не просто инструмент, это ваш помощник для изучения и освоения API. Если вы только начинаете работу с Multilogin X или уже настраиваете сложные цепочки действий, наша API-документация значительно облегчит вам жизнь.

Левая боковая панель: коллекция эндпоинтов

Здесь находятся все основные инструменты, сгруппированные по папкам:

• Launcher: запуск и остановка профилей, просмотр метаданных. 
• Profile Access Management: управление доступом к профилям и API. 
• Profile Management: создание, удаление и редактирование профилей. 
• Browser Profile Data: управление данными внутри профилей. 
• Proxy: настройка и подключение прокси. 
• Pre-made Cookies: сбор надежных cookie для имитации реалистичного поведения пользователя. 
• Script Runner: запуск автоматизированных скриптов. 
• Profile Import/Export: импорт и экспорт профилей. 
• Object storage: загрузка и скачивание файлов из хранилища. 

Из чего состоит эндпоинт

Каждый эндпоинт показывает, как правильно отправить запрос. Вот что вы увидите, когда откроете эндпоинт:

• Тип метода: GET, POST, PUT или DELETE — показывает, какое действие выполняет запрос. 
• Путь эндпоинта: конкретный URL для доступа. 
• Параметры:
  • Заголовки: например, токен авторизации. 
  • Параметры запроса: дополнительные данные, которые можно передать в URL. 
  • Переменные пути: части URL, которые меняются. 
• Пример текста запроса: что нужно отправить в POST- или PUT-запросе. 
• Примеры JSON: шаблон ответа, который вы получите. 

Эндпоинты — это как карточки с точными инструкциями: они показывают, какую информацию отправлять и что ждать в ответ. Просто копируйте пример и следуйте ему — так вы избежите ошибок.

Примеры запросов и ответов

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

• Они служат шаблонами: копируйте и вставляйте прямо в Postman!
• Особенно полезно при построении последовательностей или отладке ошибок.
• Вы можете изменить язык кодирования в верхней панели.
• Ответ автоматически приходит в формате JSON. 

Верхняя панель: стили визуализации

Верхняя панель позволяет настроить предпочтительный стиль визуализации. 

Меню «Layout» позволяет выбрать, как будет располагаться содержимое страницы:

• Один столбец: содержимое запроса и примеры запросов отображаются вертикально.
• Двойной столбец: содержимое запроса расположено в центре; примеры запросов и ответов расположены справа.

Меню «Language» позволяет выбрать нужный язык кодирования. 

С помощью значка Engine справа вы можете редактировать определенные критерии на нужном языке:

• Как запросы будут отображаться на вашем языке программирования:
  • Установка количества и типа отступов. 
  • Возможность обрезать ненужные детали. 
• Как запросы должны вести себя технически:
  • Выбор лимита времени ожидания запроса. 
  • Возможность активировать HTTP-перенаправление. 

Верхняя панель: Run in Postman

В самом правом углу верхней панели вы найдете кнопку «Run in Postman»:

1. Нажмите «Run in Postman» → вы сможете экспортировать эндпоинты напрямую.
2. Загрузите и установите Postman. 
3. Нажмите «Postman for <ваша ОС>» (рекомендуется). 
4. В «Импорт коллекции» → выберите папку для импорта коллекции Multilogin X API. 
5. Нажмите «Импорт».

Настройте локальную среду Postman

Уже добавили коллекцию в свой Postman? Вы должны увидеть ту же документацию, только в вашем локальном рабочем пространстве.