stocks.php¶

В этой статье

Методы API

stocks/list

stocks/order

stocks/show

Модуль управления стоковыми серверами: получение списка доступных предложений и детальная информация о конкретном сервере

Методы API¶

Метод	Действие	Описание
`list`	получение списка	Возвращает список доступных стоковых серверов с учетом локации, группы и прав пользователя.
`order`	оформление заказа	Размещение заказа на сервер с указанием параметров конфигурации (ОС, диски, сеть и т.д.). Метод может требовать верификации пользователя.
`show`	получение информации	Возвращает детальную информацию о конкретном сервере.

stocks/list¶

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

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "list",
"servers": [
{
"id": 123,
"name": "Stock Server Example",
"status": "active",
"location": "NL",
"price": {
"EUR": 49.99,
"RUB": 5000
}
}
]
}

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

{
"code": -2,
"message": "Invalid hash"
}

stocks/order¶

Размещение заказа на сервер с указанием параметров конфигурации (ОС, диски, сеть и т.д.). Метод может требовать верификации пользователя.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `order`
token	✅	string	Токен авторизации для проверки прав доступа.
id	❌	integer	ID сервера (если применимо).
location	❌	string	Локация сервера.
group	❌	string	Группа серверов.
deploy_period	❌	string	Период оплаты заказа.
disk_mirror	❌	integer	Схема зеркалирования дисков. Допустимые значения: -1.
os_id	❌	integer	ID операционной системы.
hostname	❌	string	Имя хоста сервера. По умолчанию пустая строка.
jenkins_task	❌	integer	ID задачи Jenkins для автоматизации развертывания. По умолчанию -1.
traffic_plan	❌	string	План трафика.
ssh_key	❌	string	Публичный SSH ключ для доступа к серверу. По умолчанию пустая строка.
post_install_script	❌	string	Скрипт после установки (post-install script). По умолчанию пустая строка.
post_install_callback	❌	string	URL или идентификатор callback для уведомления о завершении установки. По умолчанию пустая строка.
deploy_comment	❌	string	Комментарий к заказа. По умолчанию пустая строка.
deploy_notify	❌	boolean	Флаг уведомления о развертывании. По умолчанию 1 (true).
imitate_deploy	❌	boolean	Запуск в режиме имитации развертывания. (только для тестирования).

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

curl -s "https://invapi.hostkey.ru/stocks.php" -X POST \
--data "action=order" \
--data "token=YOUR_TOKEN" \
--data "os_id=10" \
--data "hostname=my-server"

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

{
"result": "OK",
"action": "order",
"data": {}
}

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

{
"code": -1,
"message": "$module/order: only verified users may place orders for new servers",
"verification_request": 1
}

stocks/show¶

Возвращает детальную информацию о конкретном сервере.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/stocks.php" -X POST \
--data "action=show" \
--data "id=123"

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

{
"result": "OK",
"action": "show",
"server_data": {
"id": 123,
"name": "Server Name",
"status": "active",
"ip": "1.2.3.4",
"location": "DE"
}
}

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

{
"code": -2,
"message": "invalid token, logout"
}