jira.php¶

Модуль интеграции с Jira для создания тикетов поддержки по управлению серверами (питание, перезагрузка, KVM) и запросам на помощь продажам.

Методы API¶

Метод	Действие	Описание
`request_PXEboot`	запрос на загрузку с PXE	Создает тикет в Jira для ручной загрузки сервера с PXE, если отсутствует удаленное управление.
`request_assistance`	запрос помощи в Jira	Отправляет запрос на техническую или коммерческую помощь через создание тикета в Jira, проверяя наличие дубликатов и собирая данные о сервере и биллинге.
`request_check`	запрос проверки сервера	Создает тикет в Jira для проверки и загрузки сервера в ОС при отсутствии удаленного управления.
`request_kvm`	запрос подключения KVM	Создает тикет в Jira для подключения IP KVM к серверу.
`request_poff`	запрос выключения питания	Создает тикет в Jira для ручного выключения питания сервера.
`request_pon`	запрос включения питания	Создает тикет в Jira для ручного включения питания сервера.
`request_reboot`	запрос перезагрузки	Создает тикет в Jira для ручной перезагрузки сервера.

jira/request_PXEboot¶

Создает тикет в Jira для ручной загрузки сервера с PXE, если отсутствует удаленное управление.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "request_PXEboot",
"jira_url": "https://jira.hostkey.com/browse/SUP-12345",
"jira_issue": "SUP-12345"
}

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

{
"code": -2,
"message": "token required",
"description": "Отсутствует токен авторизации"
}

jira/request_assistance¶

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

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `request_assistance`
token	✅	string	Токен авторизации пользователя
id	✅	integer	ID сервера
cancellation_type	❌	string	Тип отмены (по умолчанию: -)
cancellation_reason	❌	string	Причина отмены (по умолчанию: -)
terminate_reason_custom	✅	string	Подробное описание проблемы (обязательно для создания тикета)
terminate_move_to_provider	❌	string	Желание перейти к другому провайдеру (по умолчанию: -)
terminate_reorder	❌	string	Желание переоформить услугу позже (по умолчанию: -)
terminate_contact	❌	string	Способ связи с отделом продаж/поддержки (по умолчанию: -)

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

curl -s "https://invapi.hostkey.ru/jira.php" -X POST \
--data "action=request_assistance" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "terminate_reason_custom=My problem description"

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

{
"result": "OK",
"action": "request_assistance",
"jira_url": "https://jira.hostkey.com/browse/TASK-123",
"jira_issue": "TASK-123"
}

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

``` { "ASSISTANCE_DESCRIPTION_REQUIRED": { "result": -1, "action": "request_assistance", "error": "Problem description is required.", "code": "ASSISTANCE_DESCRIPTION_REQUIRED" }, "ASSISTANCE_TICKET_EXISTS": { "result": -1, "action": "request_assistance", "error": "There is already an open assistance request for this server: TASK-123", "code": "ASSISTANCE_TICKET_EXISTS", "jira_url": "https://jira.hostkey.com/browse/TASK-123", "jira_issue": "TASK-123" }, "ASSISTANCE_TICKET_SEARCH_FAILED": { "result": -1, "action": "request_assistance", "error": "Unable to check existing assistance request, please try again later.", "code": "ASSISTANCE_TICKET_SEARCH_FAILED" }, "INVALID_SERVER": { "result": -1, "error": "Jira/request_assistance: invalid server id 0" } }

```

jira/request_check¶

Создает тикет в Jira для проверки и загрузки сервера в ОС при отсутствии удаленного управления.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Название действия (должно быть `request_check`)
token	✅	string	Токен авторизации пользователя
id	✅	int	Идентификатор сервера

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

curl -s "https://invapi.hostkey.ru/jira.php" -X POST \
--data "action=request_check" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345"

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

{
"result": "OK",
"action": {
  "permission": "eq/console",
  "subject": "CP request: Check the server $id please",
  "message": "Dear HOSTKEY support, please check and boot the server $id into OS since it doesn't have remote control - something is wrong. \n This is automated message from INVAPI, no extra verification required."
},
"jira_url": "https://jira.hostkey.com/browse/SUP-11111",
"jira_issue": "SUP-11111"
}

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

{
"code": -2,
"message": "token required",
"error_data": {}
}

jira/request_kvm¶

Создает тикет в Jira для подключения IP KVM к серверу.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Название действия (должно быть 'request_kvm')
token	✅	string	Токен авторизации пользователя
id	✅	int	Идентификатор сервера

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

curl -s "https://invapi.hostkey.ru/jira.php" -X POST \
--data "action=request_kvm" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345"

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

{
"result": "OK",
"action": {
  "permission": "eq/console",
  "subject": "CP request: Connect IP KVM to the server $id please",
  "message": "Dear HOSTKEY support, please connect KVM to the server $id since it doesn't have remote control. \n This is automated message from INVAPI, no extra verification required."
},
"jira_url": "https://jira.hostkey.com/browse/SUP-22222",
"jira_issue": "SUP-22222"
}

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

{
"code": -2,
"message": "token required",
"error_data": {}
}

jira/request_poff¶

Создает тикет в Jira для ручного выключения питания сервера.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Название действия (должно быть 'request_poff')
token	✅	string	Токен авторизации пользователя
id	✅	int	Идентификатор сервера

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

curl -s "https://invapi.hostkey.ru/jira.php" -X POST \
--data "action=request_poff" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345"

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

{
"result": "OK",
"action": {
  "permission": "eq/off",
  "subject": "CP request: Manual power OFF the server $id please",
  "message": "Dear HOSTKEY support, please power off the server $id since it doesn't have remote control. \n This is automated message from INVAPI, no extra verification required."
},
"jira_url": "https://jira.hostkey.com/browse/SUP-33333",
"jira_issue": "SUP-33333"
}

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

{
"code": -2,
"message": "token required",
"error_data": {}
}

jira/request_pon¶

Создает тикет в Jira для ручного включения питания сервера.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/jira.php" -X POST \
--data "action=request_pon" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345"

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

{
"result": "OK",
"action": "request_pon",
"jira_url": "https://jira.hostkey.com/browse/SUP-44444",
"jira_issue": "SUP-44444"
}

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

{
"code": -2,
"message": "token required",
"error_data": {}
}

jira/request_reboot¶

Создает тикет в Jira для ручной перезагрузки сервера.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/jira.php" -X POST \
--data "action=request_reboot" \
--data "token=YOUR_TOKEN" \
--data "id=12345"

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

{
"result": "OK",
"action": {
  "permission": "eq/reboot",
  "subject": "CP request: Manual reboot the server $id please",
  "message": "Dear HOSTKEY support, please reboot the server $id since it doesn't have remote control. \n This is automated message from INVAPI, no extra verification required."
},
"jira_url": "https://jira.hostkey.com/browse/SUP-55555",
"jira_issue": "SUP-55555"
}

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

{
"code": -2,
"message": "token required",
"error_data": {}
}