Описание API интерфейса

HASHSTREM предоставляет API интерфейс при помощи которого Вы сможете интегрировать мониторинг и управление майнерами в свое собственное программное обеспечение.

Включение API

  • Запустите HASHSTREM сервер в автономном режиме.
  • Перейдите в меню «Обслуживание и настройка»
  • Откройте вкладку «API интерфейс»
  • Задайте ключ доступа и установите переключатель в активное состояние.

Описание API интерфейса

Вы можете обмениваться данными с сервером путем отправки на его адрес POST запросов. Запросы и ответы сервера представлены в виде JSON данных.

Запрос статистических данных

Пример запроса:

{
	"id": "login",
	"auth": "pin"
}
КлючЗначениеОписание
id login Запрос предоставления статистики
auth Произвольная строка, хешированная в md5Код авторизации

Пример ответа:

{
	"login_result": "auth_ok",
	"work": 0,
	"stopped": 0,
	"daylost": 31,
	"limit_stantion": 50,
	"hash_panel": Dd7d0nfnnd66s5mjdjhs,
  "ver_api": "12"
}
КлючЗначениеОписание
login_result auth_ok \ auth_falseАвторизация успешна \ Авторизация запрещена
work INTКол-во станций с активным майнером
stopped INT Кол-во станций с остановленным майнером
daylost INT Остаток дней подписки
limit_stantion INTПредел станций установленный в подписке
hash_panel STRID панели, 32 символа
ver_api INTВерсия API сервера

Запрос списка рабочих станций

Пример запроса:


{
	"id": "get_stantion",
	"auth": "pin*"
}

Пример ответа (массив):

[
	"ip": "127.0.0.1",
	"os": "win",
	"memory": "3 Gb \ 8 Gb",
	"miner": "xmrig.exe",
	"miner_stat": "ЗАПУЩЕН",
	"comment": "no_comment",
	"hr": "154 h\s",
	"ver": "105",
	"key_param": "--url pool.ru:80 --user 85LtF7v7FiRMv6w8e"
], [
	"ip": "127.0.0.1",
	"os": "win",
	"memory": "3 Gb \ 8 Gb",
	"miner": "xmrig.exe",
	"miner_stat": "ЗАПУЩЕН",
	"comment": "no_comment",
	"hr": "134 h\s",
	"ver": "105",
	"key_param": "--url pool.ru:80 --user 85LtF7v7FiRMv6w8e"
]
КлючЗначениеОписание
ipSTRIP адрес станции:ID соединения
oswin\linuxПлатформа клиента
memory strСвободно ОЗУ\Итого физической ОЗУ
miner strИмя майнера установленного в системе
miner_stat str(Запущен\Остановлен\Запуск…\Остановка…)Состояние майнера
comment strКомментарий станции
hrstrХешрейт станции (disabled — если отключен)
ver strВерсия клиента
key_param strКлючи с которыми запущен майнер

Запрос актуальных данных и состояния рабочей станции

Пример запроса


{
	"id": "getStantionInfo",
	"auth": "pin*",
        "ip": "127.0.0.1:454124"
}
КлючОписание
authКлюч доступа. Значение должно быть захешировано в MD5.
ip IP адрес станции для которой вы запрашиваете данные

Пример ответа:

{
	"online": true,
        "memory": "3 Gb \ 8 Gb",
	"minername": "xmrig.exe",
	"minerstatus": "ЗАПУЩЕН",
	"minerhr": "154 h\s",
	"minerkey": "--url pool.ru:80 --user 85LtF7v7FiRMv6w8e"
}
ключЗначениеОписание
online BOOLСтанция в сети
memory strОЗУ устройства
minername strНазвание майнера
minerstatus str(Запущен\Остановлен\Запуск…\Остановка…) Состояние майнера
minerhr strХешрейт майнера
minerkey str (base64)Ключи майнера

Запрос списка избранных майнеров

Пример запроса:


{
	"id": "getminerlist",
	"auth": "pin*"
}

Пример ответа (массив):

[
	"minername": "My miner v12",
	"os": "linux",
	"x64": "https://myserv.com/miner64.zip",
	"x86": "https://myserv.com/miner86.zip",
	"zip-exe": "xmrig.exe",
	"system-exe": "xmrig.exe"
]
КлючЗначениеОписание
minername strНазвание майнера в списке
os win\linux Платформа майнера
x64 str url
x86 str url
zip-exe str Название исполняемого файла в архиве с майнером
system-exe str Название исполняемого файла под которым будет работать майнер

Запуск майнера


{
	"id": "starting-miner",
	"auth": "pin*",
        "ip": "127.0.0.1",
	"key-miner": "--url pool.ru:80 --user 85LtF7v7FiRMv6w8e",
	"api-algo": 0,
        "api-port": "1010"
}
КлючЗначениеОписание
id strЗаголовок пакета.
auth str(md5)Ключ доступа. Значение должно быть захешировано в MD5.
ip strIP адрес станции для которой выполняется комманда.
key-minerstr(base64)Ключи запуска майнера. Значение должно быть закодировано в Base64
api-algo int-1 — off \ 0 — xmrig \ 1 — gmainer
api-port strПорт API майнера

Установка майнера

{
	"id": "install-miner",
	"auth": "pin*",
	"ip": "127.0.0.1",
	"miner": {

		"minername": "My miner v12",
		"os": "linux",
		"x64": "https://myserv.com/miner64.zip",
		"x86": "https://myserv.com/miner86.zip",
		"zip-exe": "xmrig.exe",
		"system-exe": "xmrig.exe"
	}
}

Остановка майнера


{
	"id": "stop-miner",
	"auth": "pin*",
        "ip": "127.0.0.1"

}

Если вы нашли ошибку, пожалуйста, выделите фрагмент текста и нажмите Ctrl+Enter.

Содержание
Send a Message

Сообщить об опечатке

Текст, который будет отправлен нашим редакторам: