licenses.php¶

В этой статье

Методы API

licenses/licenses_journal_list

licenses/licenses_update_date_expire

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

Методы API¶

Метод	Действие	Описание
`licenses_journal_list`	получение списка записей в журнале лицензий	Возвращает список записей журнала лицензий с возможностью фильтрации по биллингу, типу лицензии и периоду времени.

licenses/licenses_journal_list¶

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

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `licenses_journal_list`
token	✅	string	Токен авторизации пользователя
billing	❌	integer	Идентификатор биллинга для фильтрации записей журнала
family	❌	string	Тип лицензии (семейство) для фильтрации в журнале
period_from	❌	string	Дата начала периода фильтрации записей журнала
period_to	❌	string	Дата окончания периода фильтрации записей журнала

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

curl -s "https://invapi.hostkey.ru/licenses.php" -X GET \
--data "action=licenses_journal_list" \
--data "token=HOSTKEY_TOKEN" \
--data "billing=1" \
--data "family=standard" \
--data "period_from=2024-01-01T00:00:00Z" \
--data "period_to=2024-01-31T23:59:59Z"

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

{
"result": "OK",
"action": "licenses_journal_list",
"data": [
{
"id": 12345,
"license_type": "standard",
"billing_id": 1,
"date_from": "2024-01-01T00:00:00Z",
"date_to": "2024-01-31T23:59:59Z",
"status": "active"
}
]
}

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

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

licenses/licenses_update_date_expire¶

Запускает процесс обновления дат истечения срока действия лицензий. Метод переведен в режим ожидания отключения (retired) и вызывается планировщиком задач.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"module": "licenses",
"action": "licenses_update_date_expire",
"data": [
{
"cid": 123,
"id": 456,
"name": "license_item",
"expiredate": "2025-12-31T23:59:59Z",
"pricelist": {
"EUR": 49.99,
"RUB": 5000
},
"pricelist_id": 789,
"ip": "192.168.1.1"
}
]
}

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

{
"400": {
"code": 400,
"message": "Please provide acton"
},
"500": {
"code": -1,
"message": "Internal error during update",
"details": {
"error": "Invalid response from ISPManager API: ..."
}
}
}