employees.php¶

Модуль управления сотрудниками: управление записями (добавление, обновление, удаление), просмотр списка и получение истории действий.

Методы API¶

Метод	Действие	Описание
`add_history`	Добавление записи в историю для сущности	Создает новую запись в журнале истории (лог) для указанной сущности.
`history`	Получение истории записей	Возвращает список записей истории для указанного набора ID сотрудников.

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=123" \
--data "message=VALUE"

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

{
"result": "OK",
"action": "add_history",
"id": 123,
"message": "Запись успешно добавлена"
}

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

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

employees/history¶

Возвращает список записей истории для указанного набора ID сотрудников.

HTTP-метод: POST|GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `history`
token	✅	string	Токен авторизации
id	✅	integer	ID сотрудника для получения истории
type	❌	`array<string>`	Тип записей в истории. Принимает несколько значений: type[]=val1&type[]=val2
date_from	❌	string	Дата начала периода получения истории (ISO-формат).

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

curl -s "https://invapi.hostkey.ru/employees.php" -X POST \
--data "action=history" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "type[]=val1" \
--data "type[]=val2"

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

{
"result": "OK",
"action": "history",
"history": [
{
"id": 50,
"type": "note",
"message": "Изменение данных сотрудника",
"created_at": "2024-01-15T10:30:00Z"
}
]
}

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

{
"code": -1,
"message": "Ошибка получения истории"
}