leasing_contracts¶

В этой статье

Методы API

leasing_contracts/create

leasing_contracts/delete

leasing_contracts/get

leasing_contracts/list

leasing_contracts/show_servers

leasing_contracts/update

leasing_contracts/update_server_list

(описание будет добавлено при генерации)

Методы API¶

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

leasing_contracts/create¶

Создает новый договор лизинга.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `create`
token	✅	string	Токен авторизации
params[contract_start]	✅	string	Дата начала действия договора.
params[contract_end]	✅	string	Дата окончания действия договора.
params[company_id]	✅	integer	ID компании.

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

curl -s "https://invapi.hostkey.ru/leasing_contracts.php" -X POST \
--data "action=create" \
--data "token=HOSTKEY_TOKEN" \
--data "params[contract_start]=2024-01-01T00:00:00Z" \
--data "params[contract_end]=2025-01-01T00:00:00Z" \
--data "params[company_id]=5"

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

{
"result": "OK",
"module": "leasing_contracts",
"action": "create",
"contract": {
"id": 124,
"company_id": 5,
"contract_start": "2024-01-01T00:00:00Z",
"contract_end": "2025-01-01T00:00:00Z",
"contract_data": {},
"contract_info": {}
}
}

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

{
"400": [
{
"message": "Please provide params"
},
{
"message": "Please provide contract_start, contract_end"
},
{
"message": "Please provide company_id"
},
{
"message": "Invalid date format for contract_start or contract_end"
},
{
"message": "contract_start cannot be greater than contract_end"
}
],
"404": [
{
"message": "Action is not recognized"
}
]
}

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",
"module": "leasing_contracts",
"action": "delete"
}

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

{
"400": [
{
"message": "Please provide id"
}
],
"404": [
{
"message": "Leasing contract not found"
}
]
}

leasing_contracts/get¶

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

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"module": "leasing_contracts",
"action": "get",
"contract": {
"id": 123,
"company_id": 5,
"contract_start": "2024-01-01T00:00:00Z",
"contract_end": "2025-01-01T00:00:00Z",
"contract_data": {},
"contract_info": {}
}
}

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

{
"400": [
{
"message": "Please provide id"
}
],
"404": [
{
"message": "Leasing contract not found"
}
]
}

leasing_contracts/list¶

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

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list`
token	✅	string	Токен авторизации
params[company_id]	❌	integer	ID компании для фильтрации договоров.

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

curl -s "https://invapi.hostkey.ru/leasing_contracts.php" -X POST \
--data "action=list" \
--data "token=HOSTKEY_TOKEN" \
--data "params[company_id]=10"

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

{
"result": "OK",
"module": "leasing_contracts",
"action": "list",
"contracts": [
{
"id": 1,
"contract_start": "2024-01-01",
"contract_end": "2025-01-01",
"contract_data": {},
"company_id": 10,
"contract_info": {}
}
]
}

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

{
"PlatformException": [
{
"code": 400,
"message": "Please provide acton"
},
{
"code": 404,
"message": "Action is not recognized"
}
]
}

leasing_contracts/show_servers¶

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

HTTP-метод: POST

Параметры:

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

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

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

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

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

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

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

leasing_contracts/update¶

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

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `update`
token	✅	string	Токен авторизации
id	✅	integer	ID договора для обновления.

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

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

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

{
"result": "OK",
"module": "leasing_contracts",
"action": "update",
"contract": {
"id": 123,
"contract_start": "2024-01-01T00:00:00Z",
"contract_end": "2025-01-01T00:00:00Z",
"contract_data": {},
"company_id": 5,
"contract_info": {}
}
}

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

{
"400": [
{
"message": "Please provide id and params"
},
{
"message": "Please provide contract_start, contract_end"
},
{
"message": "Please provide company_id"
},
{
"message": "Invalid date format for contract_start or contract_end"
},
{
"message": "contract_start cannot be greater than contract_end"
}
],
"404": [
{
"message": "Leasing contract not found"
}
]
}

leasing_contracts/update_server_list¶

Заменяет текущий список серверов в договоре на новый.

HTTP-метод: POST

Параметры:

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

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

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

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

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

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

{
"400": [
"Please provide id and params",
"Server {id} is already bound to contract",
"Server {id} is not in the same location as the leasing company",
"Server {id} is not Rent"
],
"404": "Action is not recognized"
}