Интеграция со сторонними сервисами

Staffcop Enterprise предоставляет интерфейс для загрузки в систему данных от сторонних приложений.

Добавлять события из сторонних приложений в систему можно при помощи API. Для этого включите опцию Доступ к API разрешен.

Для передачи событий рекомендуем использовать HTTPS.

Список параметров (POST или GET, рекомендуем POST):

Параметр

Описание

secret

Ключ API из параметров сервера.

local_time

Время события (UTC).

event_type_id

Тип события. Указаны в agent/fixtures/event_type.json.

computer_name

Имя компьютера (опционально).

user_name

Имя пользователя (опционально). Указывается в формате user@domain.

exe_path

Путь к приложению (опционально). Указывается в формате C:\some\app.exe.

window_title

Заголовок или название чата (опционально).

text_data

Текст сообщеня. Поддерживаются безопасные HTML теги.

sender

Отправитель. Формат: contact@domain.

recipients

Получатели (через запятую).

file1.txt
file2.txt

Прикреплённые файлы.
Тип запроса должен быть POST multipart/form-data

Возвращаемые значения:

  • ID события (код 200);

  • неверный ключ или API отключено (код 403);

  • трасса ошибки (код 500)

Пример использования

curl

-F «secret=vi123p8rzgqwerdjioea0987kikgj9p2d4casdf804fqmaucq1y1neeg3n4hleg»
-F «local_time=2023-11-14 14:00:00.00Z»
-F «event_type_id=8»
-F «computer_name=user1-pc»
-F «user_name=user 1»
-F «exe_path=c:test/app.exe»
-F «window_title=Заголовок или название чата»
-F «text_data=Текст <b>подмножество HTML</b>»
-F «sender=test»
-F «recipients=test2,test3»
-F «file1.sh=@api/test_api.sh»
-F «file2.sh=@api/test_api.sh»
http://localhost/api/event/