employees.php¶

В этой статье

Методы API

employees/add

employees/add_history

employees/history

employees/list

employees/remove

employees/servers

employees/show

employees/update

API endpoint for managing employee entities, including their lifecycle, history tracking, and associated server information.

Методы API¶

Метод	Действие	Описание
`add`	добавление сотрудника	Создает новую запись о сотруднике в базе данных.
`add_history`	добавление записи в историю	Добавляет новую запись в журнал истории для сущности.
`history`	получение истории	Извлекает записи логов для указанного типа и диапазона дат.
`list`	получение списка сотрудников	Возвращает список сотрудников с применением фильтров.
`remove`	удаление сотрудника	Удаляет запись о сотруднике из локального кэша.
`servers`	получение серверов сотрудника	Возвращает список доступных опций/серверов для конкретного сотрудника.
`show`	просмотр сотрудника	Возвращает данные о сотруднике по его логину.
`update`	обновление сотрудника	Обновляет данные существующего сотрудника по его логину. Принимает набор параметров для изменения профиля.

employees/add¶

Создает новую запись о сотруднике в базе данных.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add`
token	✅	string	Токен авторизации
params[Login]	✅	string	Логин сотрудника.
email	❌	string	Электронная почта сотрудника.
E_mail	❌	string	Электронная почта сотрудника (альтернативный ключ).
name	❌	string	Имя сотрудника для создания новой записи.

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

curl -s "https://invapi.hostkey.ru/employees.php" -X POST \
--data "action=add" \
--data "token=HOSTKEY_TOKEN" \
--data "params[Login]=jdoe" \
--data "email=jdoe@example.com" \
--data "name=John Doe"

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

{
"result": "OK",
"action": "add",
"data": {
"ID": 123,
"Login": "jdoe",
"Name": "John Doe",
"E_Mail": "jdoe@example.com",
"Group_fk_id": 5,
"is_deleted": 0,
"flag_api_allowed": 0,
"position": null,
"Phone": "",
"Tell": "",
"Skype": "",
"Icq": "",
"ldap_groups": []
}
}

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

{
"code": 400,
"message": "Please provide employee's Login"
}

employees/add_history¶

Добавляет новую запись в журнал истории для сущности.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"module": "employees",
"action": "add_history",
"id": 123
}

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

{
"400": [
{
"message": "Please provide request ID"
},
{
"message": "Invalid history message"
}
],
"401": [
{
"message": "Authorization required"
}
],
"403": [
{
"message": "Authorization required"
}
],
"404": [
{
"message": "Action is not recognized"
}
]
}

employees/history¶

Извлекает записи логов для указанного типа и диапазона дат.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `history`
token	✅	string	Токен авторизации
id	❌	`array<integer>`	Идентификаторы сущностей для фильтрации.
type	❌	`array<string>`	Типы записей истории.
date_from	❌	string	Дата начала истории (ISO-дата).
component	❌	string	Идентификатор компонента для фильтрации истории событий.
date_to	❌	string	Конечная дата в рамках временного интервала для выборки записей.

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

curl -s "https://invapi.hostkey.ru/employees.php" -X POST \
--data "action=history" \
--data "token=HOSTKEY_TOKEN" \
--data "id[]=1" \
--data "id[]=2" \
--data "type[]=note" \
--data "type[]=system"

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

{
"result": "OK",
"module": "employees",
"action": "history",
"data": {
"history": [
{
"id": 0,
"date": "2024-01-15T10:30:00Z",
"type": "note",
"message": "--- End of log ---",
"login": "SYSTEM"
}
]
}
}

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

{
"400": {
"message": "No action specified"
},
"401": {
"message": "Authorization required"
},
"403": {
"message": "Authorization required"
},
"404": {
"message": "Action is not recognized"
}
}

employees/list¶

Возвращает список сотрудников с применением фильтров.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list`
token	✅	string	Токен авторизации
Login	❌	string	Поиск по точному совпадению логина.
Name	❌	string	Поиск по части имени (substring).
Group_fk_id	❌	integer	ID группы (OU) сотрудника.
ldap_groups	❌	`array<string>`	Список LDAP групп. Принимает несколько значений: ldap_groups[]=group1&ldap_groups[]=group2
active	❌	string	Фильтр по активности (word). Если передано значение, выбираются сотрудники с флагом is_deleted = 0.

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

curl -s "https://invapi.hostkey.ru/employees.php" -X POST \
--data "action=list" \
--data "token=HOSTKEY_TOKEN" \
--data "Login=admin" \
--data "ldap_groups[]=group1" \
--data "ldap_groups[]=group2"

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

{
"result": "OK",
"module": "employees",
"action": "list",
"data": [
{
"ID": 1,
"Login": "admin",
"Name": "Administrator",
"active": true,
"ldap_groups": [],
"tags": {}
}
]
}

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

{
"400": {
"message": "No action specified"
},
"401": {
"message": "Authorization required"
},
"403": {
"message": "Authorization required"
},
"404": {
"message": "Action is not recognized"
}
}

employees/remove¶

Удаляет запись о сотруднике из локального кэша.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/employees.php" -X POST \
--data "action=remove" \
--data "token=HOSTKEY_TOKEN" \
--data "Login=jdoe"

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

{
"result": "OK",
"module": "employees",
"action": "remove",
"data": [
{
"ID": 123,
"Login": "jdoe",
"ldap_groups": []
}
]
}

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

{
"400": "Please provide employee's Login",
"401": "Authorization required",
"403": "Authorization required",
"404": "Action is not recognized"
}

employees/servers¶

Возвращает список доступных опций/серверов для конкретного сотрудника.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"module": "employees",
"action": "servers",
"data": [
{
"id": 0,
"ref_tableName": "string",
"owner": "string",
"Condition_Component": "string",
"ip": "string",
"location": "string",
"config": "string",
"full_location": "string",
"preset": "string"
}
]
}

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

{
"404": [
{
"message": "Employee ID required"
}
],
"500": [
{
"message": "Failed to list servers for employee empl:{id} : {error}"
}
]
}

employees/show¶

Возвращает данные о сотруднике по его логину.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/employees.php" -X POST \
--data "action=show" \
--data "token=HOSTKEY_TOKEN" \
--data "Login=jdoe"

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

{
"result": "OK",
"module": "employees",
"action": "show",
"data": {
"ID": 123,
"Login": "jdoe",
"Name": "John Doe",
"E_Mail": "jdoe@example.com",
"is_deleted": 0,
"tags": {},
"ldap_groups": [
"group1",
"group2"
]
}
}

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

{
"400": "Please provide employee's Login",
"404": "Unable to find employee with login {Login}"
}

employees/update¶

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

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/employees.php" -X POST \
--data "action=update" \
--data "token=HOSTKEY_TOKEN" \
--data "Login=jdoe"

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

{
"result": "OK",
"module": "employees",
"action": "update",
"data": {
"E_Mail": "user@example.com",
"Group_fk_id": 123,
"Icq": "79990000000",
"Login": "jdoe",
"Name": "John Doe",
"Phone": "+79991234567",
"Skype": "jdoe_skype",
"Tell": "89991234567",
"email": "jdoe@example.com",
"flag_api_allowed": 1,
"is_deleted": 0,
"position": "Manager",
"ldap_groups": [
"group1",
"group2"
],
"tags": {}
}
}

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

{
"400": "Please provide employee's Login and entity data",
"403": "Authorization required",
"401": "Authorization required",
"404": "Action is not recognized"
}