rhr.php¶

Модуль управления заявками на удаленные работы (Remote Hands Requests): создание, фильтрация, обновление статусов и коммуникация по заявкам.

Методы API¶

Метод	Действие	Описание
`add`	создание запроса	Создает новый запрос Remote Hands (RHR). Поддерживает типы KVM, UNBLOCK и SERVICE. При наличии клиента автоматически создает тикет в системе поддержки.
`chat`	отправка сообщения в чат RHR	Отправляет сообщение в существующий запрос Remote Hands, обновляет историю переписки и при необходимости создает тикет поддержки.
`discard`	отмена/утилизация запроса	Утилизирует (отменяет) запрос Remote Hands по его ID. Если предоставлен текст ответа, он сохраняется в историю логов клиента.
`list`	получение списка запросов RHR	Возвращает список доступных задач Remote Hands с возможностью фильтрации по датам, статусам и локациям. Для клиентов дополнительно возвращается история изменений.

rhr/add¶

Создает новый запрос Remote Hands (RHR). Поддерживает типы KVM, UNBLOCK и SERVICE. При наличии клиента автоматически создает тикет в системе поддержки.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
token	❌	string	Токен авторизации
params[eq_id]	✅	integer	ID оборудования (equipment ID)
params[type]	✅	string	Тип запроса: KVM, UNBLOCK или SERVICE
params[request_origin]	❌	string	Источник запроса (например, CLIENT)
params[request]	✅	string	Текст запроса (не может содержать эмодзи)

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

curl -s "https://invapi.hostkey.ru/rhr.php" -X POST \
--data "action=add" \
--data "params[eq_id]=12345" \
--data "params[type]=KVM" \
--data "params[request]=Please restart the server"

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

{
"requests": [
{
"id": 12345,
"request": "Please restart the server",
"status": "pending",
"type": "KVM",
"created_at": "2024-05-20T12:00:00Z",
"photosExtra": "[{\"objectKey\": \"file_key_1\"}]"
}
]
}

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

``` { "code": 400, "message": "Emoji are not allowed in RHR requests" }

```

rhr/chat¶

Отправляет сообщение в существующий запрос Remote Hands, обновляет историю переписки и при необходимости создает тикет поддержки.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
id	✅	string	ID запроса (request ID)
message	✅	string	Текст сообщения для отправки в чат

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

curl -s "https://invapi.hostkey.ru/rhr.php" -X POST \
--data "id=VALUE" \
--data "message=VALUE"

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

{
"history": [
{
"id": 12345,
"message": "Hello, I need help with my server.",
"component_id": 12345,
"tags": []
}
],
"requests": [
{
"id": 67890,
"request": "Server reboot request",
"status": "active"
}
]
}

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

``` { "code": 400, "message": "Please provide request ID" }

```

rhr/discard¶

Утилизирует (отменяет) запрос Remote Hands по его ID. Если предоставлен текст ответа, он сохраняется в историю логов клиента.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
id	✅	int	ID запроса Remote Hands
params[response]	❌	string	Текст ответа для записи в историю логов клиента

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

curl -s "https://invapi.hostkey.ru/rhr.php" -X POST \
--data "id=123" \
--data "params[response]=Your response text"

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

{
"requests": [
{
"id": 123,
"status": "CANCELED",
"request_origin": "CLIENT",
"component_id": 456,
"tags": []
}
],
"history": [
{
"message": "User response text",
"created_at": "2024-01-15T10:30:00Z"
}
]
}

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

``` { "code": 400, "message": "Please provide request ID" }

```

rhr/list¶

Возвращает список доступных задач Remote Hands с возможностью фильтрации по датам, статусам и локациям. Для клиентов дополнительно возвращается история изменений.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list`
location	❌	string	Фильтр по локации
status[]	❌	string[]	Принимает несколько значений: status[]=PENDING&status[]=ACTIVE
eq_id	❌	int	ID оборудования для фильтрации
deleted	❌	boolean	Показывать удаленные записи
date_from	❌	string	Дата начала периода
date_to	❌	string	Дата окончания периода
date[]	❌	array	Массив дат для фильтрации (используется как date_issued)
token	✅	string	API-токен аутентификации

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

curl -s "https://invapi.hostkey.ru/rhr.php" -X POST \
--data "action=list" \
--data "token=HOSTKEY_TOKEN" \
--data "status[]=PENDING" \
--data "status[]=ACTIVE"

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

{
"result": "OK",
"action": "list",
"requests": [
{
"id": 12345,
"status": "active",
"location": "NL",
"date_created": "2024-01-15T10:30:00Z",
"date_assigned": "2024-01-15T11:00:00Z",
"date_started": "2024-01-15T12:00:00Z",
"date_resolved": "2024-01-15T13:00:00Z",
"date_closed": "2024-01-15T14:00:00Z",
"date_failed": null,
"resolved_by": "admin"
}
],
"history": [
{
"component_id": 12345,
"tags": [
{
"name": "system",
"value": "created"
}
]
}
]
}

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

``` { "code": -1, "message": "Empty search parameters disallowed (no known keys)" }

```