leasing_contracts.php¶

Модуль управления договорами лизинга: создание, обновление данных, удаление и управление привязкой серверов к контракту

Методы API¶

Метод	Действие	Описание
`create`	создание договора	Создает новый договор лизинга с заданными параметрами
`delete`	удаление договора	Удаляет договор лизинга и отвязывает все связанные с ним серверы
`get`	получение данных	Возвращает детальную информацию о конкретном договоре лизинга
`list`	получение списка	Возвращает список всех договоров лизинга
`show_servers`	получение списка серверов	Возвращает список ID серверов, привязанных к договору лизинга
`update`	обновление данных	Обновляет параметры существующего договора лизинга и синхронизирует привязанные серверы
`update_server_list`	обновление списка серверов	Обновляет список серверов, привязанных к договору лизинга

leasing_contracts/list¶

Возвращает список всех договоров лизинга

HTTP-метод: GET

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/leasing_contracts.php" -X GET \
--data "action=list" \
--data "token=HOSTKEY_TOKEN"

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

{
"result": "OK",
"action": "list",
"contracts": [
{
"id": 123,
"name": "Contract Example",
"status": "active",
"created_at": "2024-01-15T10:30:00Z"
}
]
}

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

{
"code": -1,
"message": "Action is not recognized"
}

leasing_contracts/get¶

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

HTTP-метод: GET

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/leasing_contracts.php" -X GET \
--data "action=get" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

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

{
"result": "OK",
"action": "get",
"contract": {
"id": 123,
"name": "Contract Example",
"status": "active",
"created_at": "2024-01-15T10:30:00Z"
}
}

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

{
"code": 400,
"message": "Please provide id"
}

leasing_contracts/update¶

Обновляет параметры существующего договора лизинга и синхронизирует привязанные серверы

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `update`
token	✅	string	Токен авторизации
id	✅	integer	ID договора лизинга
params	✅	`array<string>`	Массив параметров для обновления данных договора

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

curl -s "https://invapi.hostkey.ru/leasing_contracts.php" -X POST \
--data "action=update" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "params[]=name=Updated Contract" \
--data "params[]=status=active"

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

{
"result": "OK",
"action": "update",
"contract": {
"id": 123,
"name": "Updated Contract",
"status": "active",
"company_id": 456
}
}

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

{
"code": 400,
"message": "Please provide id and params"
}

leasing_contracts/create¶

Создает новый договор лизинга с заданными параметрами

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "create",
"contract": {
"id": 124,
"name": "New Contract",
"status": "active"
}
}

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

{
"code": 400,
"message": "Please provide params"
}

leasing_contracts/delete¶

Удаляет договор лизинга и отвязывает все связанные с ним серверы

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/leasing_contracts.php" -X POST \
--data "action=delete" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

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

{
"result": "OK",
"action": "delete"
}

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

{
"code": 400,
"message": "Please provide id"
}

leasing_contracts/show_servers¶

Возвращает список ID серверов, привязанных к договору лизинга

HTTP-метод: GET

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/leasing_contracts.php" -X GET \
--data "action=show_servers" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

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

{
"result": "OK",
"action": "show_servers",
"servers": [
101,
102,
103
]
}

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

{
"code": 400,
"message": "Please provide id"
}

leasing_contracts/update_server_list¶

Обновляет список серверов, привязанных к договору лизинга

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `update_server_list`
token	✅	string	Токен авторизации
id	✅	integer	ID договора лизинга
params[servers[]]	✅	`array<string>`	Список ID серверов для привязки. Принимает несколько значений: servers[]=1&servers[]=2
servers[]	✅	`array<string>`	Список ID серверов для привязки. Принимает несколько значений: servers[]=1&servers[]=2
servers	✅	string	Параметр `servers`

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

curl -s "https://invapi.hostkey.ru/leasing_contracts.php" -X POST \
--data "action=update_server_list" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "params[servers[]]=1" \
--data "params[servers[]]=2" \
--data "servers[]=1" \
--data "servers[]=2" \
--data "servers=1,2"

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

{
"result": "OK",
"action": "update_server_list"
}

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

{
"code": 400,
"message": "Please provide id and params"
}