Аудит — механизм позволяющий просматривать действия, которые совершал пользователь с в клиентском web-приложении.
Для работы с данным API пользователь должен быть авторизован в системе.
POST ~/audit/receiver — северное API для обработки информации, которая передается от клиентских приложений. Данные передаются в виде массива. Список полей, который требуется передавать:
- type: string — тип действия.
- message: string — описание действия.
- app_id: string — идентификатор приложения, с которого отправлен запрос.
- login: string — передается логин пользователя. По умолчанию данная информация будет получен из токен-авторизации.
В случаи успешной отправки информации результат запроса будет строка:
SUCCESS
Если при сохранении информации будет получена ошибка, то результатом будет строка:
FAIL: текст ошибки
Для упрощённой работы с web-приложениями доступна загрузка javascript объекта, который позволяет отправлять информацию на сервер используя методы этого объекта. Чтобы загрузить javscript объект нужно вызвать запрос ~/audit/scripts.js. Данный запрос доступен без авторизации, но при отправке информации, авторизация обязательна.
Описание объекта
После загрузки файла scripts.js в javascrpt будет доступен объект __audit, который является классом. Пример вызова:
new __audit({
baseUrl: string, - базовый адрес сервера
userId: integer, - идентификатор пользователя
token: string - токен авторизации
});
После инициализации объекта клиентскому приложению будет доступно две функции:
- single: (type: string, message:? string) — передача объекту одной записи;
- many: (items:any[]) — передача массива данных.
Отправка информации на сервер будет автоматической.
Примечание: Для временного хранения информации на клиенте объект __audit использует localStorage.
Описание серверного API для работы с аудитом тут http://docs.appcode.pw/docs?project=mobnius-net-server&file=modules/system-logs/router/audit.js
