API

Работа с Postman

6.3.1 Введение

Postman — популярный инструмент для тестирования API. Прошивка VNISH предоставляет REST API, доступный на каждом майнере. В этом руководстве мы расскажем, как настроить Postman для работы с этим API, начиная с самой первой настройки среды.

6.3.2 Установка

Скачайте и установите десктопное приложение Postman с официального сайта, либо используйте веб-версию Postman в браузере.

6.3.3 Получение и импорт спецификации API

API VNISH описан в формате OpenAPI. Посмотреть и скачать документацию можно прямо на майнере:

в веб-интерфейсе прошивки: раздел Тех. поддержка → API;
либо открыв в браузере адрес http://<IP_майнера>/docs. Полученный файл спецификации (JSON) используется для импорта в Postman, что избавляет от необходимости создавать все запросы вручную:

В Postman нажмите иконку «Import».
Выберите JSON-спецификацию xminer-api и загрузите.
Postman создаст коллекцию xminer-api, разложив все эндпоинты по папкам.

Важно: Postman группирует запросы не по тегам из спецификации (auth, mining и т.п.), а по первому сегменту URL.

6.3.4 Настройка окружений

В Postman есть два уровня переменных, которые стоит разделять:

Global: значения, одинаковые для всех майнеров с прошивкой VNISH.
Environment: значения, уникальные для конкретного майнера.

Шаг 1. Глобальная переменная

Откройте вкладку Environments в правой панели. Выберите Globals.
В таблице переменных кликните на строку Add variable.
Создайте переменную:

Variable: BASE_PATH
Value: /api/v1

Сохраните (Ctrl+S или кнопка сохранения в правом верхнем углу). Это общий базовый путь API, одинаковый для любого майнера на VNISH.

Шаг 2. Окружение для конкретного майнера

На вкладке Environments создайте новое окружение (например, My Miner).
Добавьте переменную:

Variable: MINER_IP
Value: IP-адрес майнера с указанием протокола, например http://<IP_адрес_майнера>

Также заведите пустую переменную AUTH_TOKEN. Она будет автоматически заполняться после входа.

Как настроить её автоматическое заполнение описано в разделе «Настройка автоматического получения и подстановки bearer-токена».

Сохраните окружение и выберите его активным в выпадающем списке окружений в правом верхнем углу веб-интерфейса Postman — без этого переменные не будут подставляться в запросы.

Шаг 3. Переменная baseUrl в коллекции

При импорте спецификации Postman автоматически создаёт в коллекции переменную baseUrl, на основе которой строится путь ко всем запросам ({{baseUrl}}/unlock, {{baseUrl}}/status и т.д.). По умолчанию она содержит только базовый путь без адреса майнера (/api/v1), поэтому её нужно донастроить.

Откройте коллекцию xminer-api → вкладка Variables.
Найдите строку baseUrl.
В колонке Value замените значение на:
```
{{MINER_IP}}{{BASE_PATH}}
```
Сохраните изменения. Теперь baseUrl автоматически собирается из переменной окружения MINER_IP и глобальной переменной BASE_PATH, и итоговый адрес выглядит так: http://<IP-майнера>/api/v1.

При смене майнера или его IP-адреса достаточно поменять значение MINER_IP в соответствующем окружении. Все запросы в коллекции автоматически подхватят новый адрес, без ручного редактирования каждого запроса.

6.3.5 Настройка Postman для автоматического получения и подстановки bearer-токена

Чтобы получить токен через /unlock и настроить Postman так, чтобы он автоматически подставлял этот токен во все последующие запросы, без ручного копирования каждый раз.

Шаг 1. Проверка активного окружения

Убедитесь, что в правом верхнем углу Postman выбрано окружение My Miner.

Шаг 2. Создание запроса `unlock`

Метод POST, URL: {{baseUrl}}/unlock.
Вкладка Body > raw > тип JSON: Вставьте приведенный ниже JSON в качестве сообщения:
```
{"pw":"пароль_устройства"}
```

Шаг 3. Скрипт автосохранения токена

Скопируйте и вставьте приведенный ниже скрипт во вкладку Scripts > Post-response:

pm.environment.unset('AUTH_TOKEN');

pm.test('Status code is 200', function () {
    pm.response.to.have.status(200);
});

const json = pm.response.json();
pm.environment.set('AUTH_TOKEN', json.token);

Скрипт стирает старое значение AUTH_TOKEN, проверяет, что сервер ответил 200 OK, достаёт поле token из тела ответа и сохраняет его в переменную окружения AUTH_TOKEN.

Откройте нужный запрос в коллекции.
Справа от кнопки Send нажмите на иконку </> (Code) — она открывает меню с готовым кодом запроса на разных языках.
В выпадающем списке найдите пункт cURL.

Авторизация и токен доступа

В API есть два независимых способа авторизации.

Работа с cURL