api_keys.php¶

В этой статье

Методы API

api_keys/add

api_keys/add_history

api_keys/count_owned

api_keys/delete

api_keys/edit

api_keys/history

api_keys/list

api_keys/list_for_customer

api_keys/list_for_server

api_keys/view

Модуль управления API-ключами: создание, редактирование, удаление и просмотр истории использования ключей с привязкой к серверам или IP-адресам.

Методы API¶

Метод	Действие	Описание
`add`	создание ключа	Создает новый API ключ. Для клиентов доступно только при наличии активных сервисов или баланса.
`add_history`	добавление записи в историю	Добавляет запись о событии в историю API ключей.
`count_owned`	подсчет собственных ключей	Возвращает количество API ключей, принадлежащих текущему пользователю.
`delete`	удаление ключа	Удаляет API ключ.
`edit`	редактирование ключа	Редактирует существующий API ключ (название, IP-адреса или привязку к серверу).
`history`	просмотр истории	Возвращает историю действий с API ключами.
`list`	получение списка ключей	Возвращает список всех API ключей пользователя.
`list_for_customer`	получение списка ключей клиента	Возвращает список всех API-ключей, принадлежащих текущему клиенту.
`list_for_server`	получение списка ключей сервера	Возвращает список API-ключей, привязанных к конкретному серверу.
`view`	просмотр ключа	Возвращает детальную информацию о конкретном API-ключе.

api_keys/add¶

Создает новый API ключ. Для клиентов доступно только при наличии активных сервисов или баланса.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add`
token	✅	string	Токен авторизации
params[name]	✅	string	Название API ключа
params[ip]	❌	`array<string>`	Список разрешенных IP-адресов или подсетей (через пробел). Принимает несколько значений: ip[]=1.2.3.4&ip[]=5.6.7.8
params[server_id]	❌	integer	ID сервера для привязки ключа. В prebill-режиме подставляется автоматически.

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

curl -s "https://invapi.hostkey.ru/api_keys.php" -X POST \
--data "action=add" \
--data "token=HOSTKEY_TOKEN" \
--data "params[name]=My Key" \
--data "params[ip[]=1.2.3.4" \
--data "params[ip[]=5.6.7.8"

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

{
"result": "OK",
"action": "add",
"data": {
"id": 123,
"name": "My Key",
"token_view": "a1b2c3d4e5f6g7h8i9j0",
"server_id": 45,
"ip": "1.1.1.1 2.2.2.2",
"created_at": "2024-05-20T12:00:00Z"
}
}

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

{
"code": -3,
"message": "api_keys_no_servers_or_balance"
}

api_keys/add_history¶

Добавляет запись о событии в историю API ключей.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "add_history",
"data": {
"id": 50,
"message": "History entry added"
}
}

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

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

api_keys/count_owned¶

Возвращает количество API ключей, принадлежащих текущему пользователю.

HTTP-метод: GET

Параметры:

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

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

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

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

{
"result": "OK",
"action": "count_owned",
"data": {
"count": 5
}
}

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

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

api_keys/delete¶

Удаляет API ключ.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "delete",
"data": {
"status": "deleted"
}
}

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

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

api_keys/edit¶

Редактирует существующий API ключ (название, IP-адреса или привязку к серверу).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `edit`
token	✅	string	Токен авторизации
params[server_id]	❌	integer	ID сервера для привязки ключа. В prebill-режиме подставляется автоматически.
params[ip]	❌	`array<string>`	Список разрешенных IP-адресов или подсетей (через пробел). Принимает несколько значений: ip[]=1.2.3.4&ip[]=5.6.7.8

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

curl -s "https://invapi.hostkey.ru/api_keys.php" -X POST \
--data "action=edit" \
--data "token=YOUR_TOKEN" \
--data "params[server_id]=45" \
--data "params[ip[]=1.2.3.4" \
--data "params[ip[]=5.6.7.8"

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

{
"result": "OK",
"action": "edit",
"data": {
"id": 123,
"name": "Updated Key",
"server_id": 45,
"ip": "1.1.1.1"
}
}

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

{
"code": -1,
"message": "Invalid server_id"
}

api_keys/history¶

Возвращает историю действий с API ключами.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "history",
"data": [
{
"id": 1,
"event": "key_created",
"details": "Key created successfully",
"date": "2024-05-20T12:00:00Z"
}
]
}

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

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

api_keys/list¶

Возвращает список всех API ключей пользователя.

HTTP-метод: GET

Параметры:

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

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

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

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

{
"result": "OK",
"action": "list",
"data": [
{
"id": 1,
"name": "Key 1",
"token_view": "abcde...",
"server_id": 10,
"ip": "1.2.3.4",
"date_created": "2024-05-20T10:00:00Z"
}
]
}

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

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

api_keys/list_for_customer¶

Возвращает список всех API-ключей, принадлежащих текущему клиенту.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "list_for_customer",
"data": [
{
"id": 123,
"name": "My API Key",
"token_view": "a1b2c3d4e5f6g7h8i9j0",
"server_id": 0,
"ip": "127.0.0.1/32",
"created_at": "2024-01-15T10:30:00Z"
}
]
}

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

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

api_keys/list_for_server¶

Возвращает список API-ключей, привязанных к конкретному серверу.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/api_keys.php" -X POST \
--data "action=list_for_server" \
--data "token=HOSTKEY_TOKEN" \
--data "server_id=10"

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

{
"result": "OK",
"action": "list_for_server",
"data": [
{
"id": 456,
"name": "Server Key",
"token_view": "z9y8x7w6v5u4t3s2r1q0",
"server_id": 10,
"ip": "192.168.1.1/32",
"created_at": "2024-02-20T15:45:00Z"
}
]
}

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

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

api_keys/view¶

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

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "view",
"data": {
"id": 123,
"name": "Production Key",
"token_view": "abc123def456ghi789j0",
"server_id": 5,
"ip": "1.1.1.1/32",
"created_at": "2024-03-01T12:00:00Z"
}
}

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

{
"code": -1,
"message": "Permission denied"
}