software.php¶

В этой статье

Методы API

software/all_software

software/app_marketplace

software/list

software/presets

Модуль управления программным обеспечением и пресетами: получение списков доступного ПО, фильтрация по параметрам сервера и отображение подходящих конфигураций (пресетов) для конкретного продукта

Методы API¶

Метод	Действие	Описание
`all_software`	полный список ПО	Возвращает полный список всего доступного программного обеспечения с учетом региональных ограничений (RU/non-RU).
`app_marketplace`	маркетплейс приложений	Возвращает пустой успешный ответ для инициализации маркета приложений.
`list`	получение списка ПО	Возвращает список доступного программного обеспечения, отфильтрованного по параметрам сервера или локации пользователя.
`presets`	получение пресетов	Возвращает список подходящих пресетов (конфигураций) для выбранного программного обеспечения, а также список совместимых операционных систем.

software/all_software¶

Возвращает полный список всего доступного программного обеспечения с учетом региональных ограничений (RU/non-RU).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `all_software`
token	✅	string	Токен авторизации

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

curl -s "https://invapi.hostkey.ru/software.php" -X POST \
--data "action=all_software" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "all_software",
"software": [
{
"id": 5,
"name": "Windows Server",
"tags": [
{
"tag": "only_russia"
}
],
"os_list": []
}
],
"debug1": "RU",
"debug2": "RU"
}

Примеры ошибок

{
"code": -1,
"message": "no software found"
}

software/app_marketplace¶

Возвращает пустой успешный ответ для инициализации маркета приложений.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `app_marketplace`
token	✅	string	Токен авторизации

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

curl -s "https://invapi.hostkey.ru/software.php" -X POST \
--data "action=app_marketplace" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK"
}

Примеры ошибок

{}

software/list¶

Возвращает список доступного программного обеспечения, отфильтрованного по параметрам сервера или локации пользователя.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list`
token	❌	string	Токен авторизации (обязателен для непубличных методов)
bill_period	❌	string	Период оплаты. Допустимые значения: hourly, monthly.
user_location	❌	string	Локация пользователя (код страны или COM). По умолчанию: COM
instance_id	❌	integer	Идентификатор предустановленного набора программного обеспечения для сервера.

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

curl -s "https://invapi.hostkey.ru/software.php" -X POST \
--data "action=list"

Пример успешного ответа

{
"result": "OK",
"action": "list",
"software": [
{
"id": 1,
"name": "Docker Engine",
"price": 10.0,
"active": 1,
"tags": [
{
"tag": "promo",
"value": "0.5",
"extra": "Standard"
}
],
"RUR_rate": 92.5
}
],
"debug": {},
"debug_licensed_soft": {
"1": "Docker Engine"
}
}

Примеры ошибок

{
"code": -1,
"message": "$module/list: no software found"
}

software/presets¶

Возвращает список подходящих пресетов (конфигураций) для выбранного программного обеспечения, а также список совместимых операционных систем.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `presets`
token	✅	string	Токен авторизации для проверки прав доступа.
id	✅	integer	Идентификатор программного обеспечения (software id) для подбора пресетов.

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

curl -s "https://invapi.hostkey.ru/software.php" -X POST \
--data "action=presets" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

Пример успешного ответа

{
"result": "OK",
"action": "presets",
"presets": [
{
"Code": 1,
"amount": 50.0,
"component_id": 123,
"hourly_com": 0.5,
"hourly_ru": 45.0,
"hourly_usd": 0.6,
"locations": "NL",
"monthly_com": 15.0,
"monthly_ru": 1350.0,
"monthly_usd": 18.0,
"preset": "Standard Config",
"price": 15.0,
"regions": [
"NL",
"DE"
],
"server_type": "Instant Dedicated Server",
"tags": [
{
"tag": "vm",
"value": "true"
}
],
"OS": {
"active": true,
"ram": 4096,
"cpu_sockets": 2,
"location": "NL"
}
}
],
"os": [
{
"id": 1,
"billing_plan": {
"USD": 1.18,
"EUR": 1.0,
"RUB": 100.0
},
"tags": []
}
],
"soft": {
"id": 123,
"name": "example_software",
"active": 1,
"tags": [
{
"tag": "os",
"value": [
"win",
"linux"
]
}
]
}
}

Примеры ошибок

{
"code": -1,
"message": "no software with id 123 was found"
}