Интеграция API

Введение

API интерфейс предназначен для разработчиков и используется для интеграции ваших приложений с системой ИНСАЙДЕР. Если у вас имеются вопросы по работе API или требуются дополнительные возможности интеграции, то свяжитесь с нами по адресу: sale@insider.sale или в техническую поддержку https://support.insider.red/

API работает по протоколу HTTP и представляет собой набор методов, с помощью которых совершаются запросы и возвращаются ответы для каждой операции. Все ответы приходят в виде JSON структур.

Начало работы

Аутентификация

Метод	Где передавать	Пример
API-ключ в URL	Query-параметр `key`	`GET /api/users/find?key=API_KEY`
API-ключ в заголовке	`Authorization`	`Authorization: API_KEY`

Работа с API

Для работы с API необходимо:

Получить ключ API_KEY в личном кабинете администратора в Настройки - Интеграции - API ключ
Использовать данный ключ в каждом запросе к API в параметрах URL или в заголовке HTTP "Authorization"

Формат запроса

URL любого API-запроса составляется следующим образом:

https://<имя-вашего-сервера-или-ip-адрес>/api/

Пример c ключом в URL:

https://<имя-вашего-сервера-или-ip-адрес>/api/users/find?key=apikey

Или c ключом в заголовке HTTP:

https://<имя-вашего-сервера-или-ip-адрес>/api/users/find

Заголовок HTTP

Authorization: apikey

Обозначения

Типы дат: yyyy-MM-dd HH:mm:ss, если не указано иное

Список методов

Пользователи — эндпоинты и параметры

Метод	Эндпоинт	Описание	Параметры
GET	`/api/users/find`	Получить список пользователей	`id`: array[long] — фильтр по ID — обязательно: нет `agentDomainId`: long — фильтр по домену — обязательно: нет `email`: string — фильтр по email — обязательно: нет `active`: boolean — по активности — обязательно: нет `statistics`: boolean — по флагу сбора статистики — обязательно: нет
POST	`/api/users/save`	Создать или обновить пользователя	`id`: long — для обновления существующего — обязательно: нет `email`: string — Email пользователя — обязательно: нет `guid`: string — GUID интеграций (Bitrix24, 1С) — обязательно: нет `upn`: string — UPN (Active Directory) — обязательно: нет `firstName`: string — обязательно при создании (если нет `id`) — обязательно: да* `lastName`: string — фамилия — обязательно: нет `secondName`: string — отчество — обязательно: нет `departmentId`: long — отдел — обязательно: нет `positionId`: long — должность — обязательно: нет `scheduleId`: long — расписание — обязательно: нет `timezone`: string — часовой пояс — обязательно: нет `active`: boolean — статус активности — обязательно: нет `deleted`: boolean — признак удаления — обязательно: нет `statistics`: boolean — включить сбор статистики — обязательно: нет
GET	`/api/users/getAccess`	Получить права пользователя	`id`: long — ID пользователя — обязательно: да
POST	`/api/users/setAccess`	Установить права пользователя	`id`: long — ID пользователя — обязательно: да `access`: object — объект прав — обязательно: нет `access.menu`: array[string] — разделы меню — обязательно: нет `access.departments`: array[long] — доступные отделы — обязательно: нет `access.users`: array[long] — доступные пользователи — обязательно: нет
POST	`/api/users/setPassword`	Сменить пароль пользователя	`id`: long — ID пользователя — обязательно: да `password`: string — новый пароль — обязательно: да
GET	`/api/users/getDistractions`	Получить отвлечения пользователя	`id`: long — ID пользователя — обязательно: да
POST	`/api/users/setDistractions`	Назначить отвлечения пользователю	`id`: long — ID пользователя — обязательно: да `distractionIds`: array[long] — список отвлечений — обязательно: нет

События календаря — эндпоинты и параметры

Метод	Эндпоинт	Описание	Параметры
GET	`/api/users/events/find`	Получить список событий календаря	`userId`: long — ID пользователя — обязательно: нет `startDate`: string — дата начала — обязательно: да `endDate`: string — дата окончания — обязательно: да
POST	`/api/users/events/save`	Создать или обновить событие календаря	`id`: long — для обновления — обязательно: нет `userId`: long — ID пользователя — обязательно: нет `type`: string — тип события — обязательно: нет `name`: string — название события — обязательно: нет `startDate`: string — дата начала — обязательно: нет `endDate`: string — дата окончания — обязательно: нет
POST	`/api/users/events/remove`	Удалить событие календаря	`id`: long — ID события — обязательно: да

Агенты — эндпоинты и параметры

Метод	Эндпоинт	Описание	Параметры
GET	`/api/agents/find`	Получить список агентов	`userId`: array[long] — фильтр по пользователям — обязательно: нет
POST	`/api/agents/create`	Создать агента	`userId`: long — связать с пользователем — обязательно: нет
POST	`/api/agents/active`	Активировать/деактивировать агента	`id`: long — ID агента — обязательно: да `active`: boolean — состояние — обязательно: да
POST	`/api/agents/setUserId`	Привязать/отвязать пользователя	`id`: long — ID агента — обязательно: да `userId`: long — ID пользователя (не указывать для отвязки) — обязательно: нет
POST	`/api/agents/remove`	Удалить агента	`id`: long — ID агента — обязательно: да

Интеграции (Active Directory) — эндпоинты и параметры

Метод	Эндпоинт	Описание	Параметры
GET	`/api/agents/domains/find`	Список интеграций AD	—
POST	`/api/agents/domains/save`	Создать/обновить интеграцию AD	`id`: long — обновление — обязательно: нет `controller`: string — контроллер домена — обязательно: нет `domain`: string — домен (если нет `id`) — обязательно: да* `login`: string — логин (если нет `id`) — обязательно: да* `password`: string — пароль — обязательно: нет `organizationalUnits`: string(JSON) — например `["/Groups/Developers"]` — обязательно: нет `createDepartments`: boolean — создавать отделы по OU — обязательно: нет
POST	`/api/agents/domains/remove`	Удалить интеграцию AD	`id`: long — ID интеграции — обязательно: да

Отделы — эндпоинты и параметры

Метод	Эндпоинт	Описание	Параметры
GET	`/api/departments/find`	Список отделов	—
POST	`/api/departments/save`	Создать/обновить отдел	`id`: long — обновление — обязательно: нет `name`: string — название отдела — обязательно: да* `departmentId`: long — родительский отдел — обязательно: нет
POST	`/api/departments/remove`	Удалить отдел	`id`: long — ID отдела — обязательно: да

Должности — эндпоинты и параметры

Метод	Эндпоинт	Описание	Параметры
GET	`/api/positions/find`	Список должностей	—
POST	`/api/positions/save`	Создать/обновить должность	`id`: long — обновление — обязательно: нет `name`: string — наименование — обязательно: да*
POST	`/api/positions/remove`	Удалить должность	`id`: long — ID должности — обязательно: да

Расписания — эндпоинты и параметры

Метод	Эндпоинт	Описание	Параметры
GET	`/api/schedules/find`	Список расписаний	`id`: array[long] — фильтр по ID — обязательно: нет
POST	`/api/schedules/save`	Создать/обновить расписание	`id`: long — обновление — обязательно: нет `name`: string — имя расписания — обязательно: да* `free`: boolean — гибкий режим (true/false) — обязательно: нет `data`: array[object] — 7 объектов Пн–Вс — обязательно: да* Если free=false:`data[].intervals[].from`, `data[].intervals[].to` (HH:mm) — обязательно: да* Если free=true:`data[].value` (HH:mm) — обязательно: да*
POST	`/api/schedules/remove`	Удалить расписание	`id`: long — ID расписания — обязательно: да

Приложения и сайты — эндпоинты и параметры

Метод	Эндпоинт	Описание	Параметры
GET	`/api/applications/find`	Список приложений/сайтов	`id`: array[long] — фильтр по ID — обязательно: нет
POST	`/api/applications/save`	Создать/обновить приложение/сайт	`id`: long — обновление — обязательно: нет `name`: string — имя — обязательно: да* `path`: string — путь/домен/шаблон — обязательно: да* `type`: string — `process` или `site` — обязательно: да* `groupId`: long — группа — обязательно: нет `title`: string — отображаемое имя — обязательно: нет
POST	`/api/applications/remove`	Удалить приложение/сайт	`id`: long — ID — обязательно: да

Политики отвлечений — эндпоинты и параметры

Метод	Эндпоинт	Описание	Параметры
GET	`/api/distractions/find`	Список политик отвлечений	—
POST	`/api/distractions/save`	Создать/обновить политику отвлечений	`id`: long — обновление — обязательно: нет `name`: string — имя политики — обязательно: да*
GET	`/api/distractions/getApplications`	Получить приложения политики	`id`: long — ID политики — обязательно: да
POST	`/api/distractions/setApplications`	Назначить приложения политике	`id`: long — ID политики — обязательно: да `applicationIds`: array[long] — список приложений — обязательно: нет
GET	`/api/distractions/getUsers`	Получить пользователей политики	`id`: long — ID политики — обязательно: да
POST	`/api/distractions/setUsers`	Назначить пользователей политике	`id`: long — ID политики — обязательно: да `userIds`: array[long] — список пользователей — обязательно: нет
POST	`/api/distractions/remove`	Удалить политику отвлечений	`id`: long — ID политики — обязательно: да

Активности — эндпоинты и параметры

Метод	Эндпоинт	Описание	Параметры
GET	`/api/activities/find`	Список активностей	`usersId`: array[long] — если нет `agentsId` — обязательно: да* `agentsId`: array[long] — если нет `usersId` — обязательно: да* `startDate`: string — дата начала — обязательно: да `endDate`: string — дата окончания — обязательно: да `type`: string — `state\|mouse\|process\|site\|screen\|keylogger\|gps` — обязательно: нет `order`: string — `asc` \| `desc` — обязательно: нет `limit`: integer — лимит — обязательно: нет `offset`: integer — смещение — обязательно: нет `search`: string — строка поиска — обязательно: нет `includeTotal`: boolean — вернуть счётчик — обязательно: нет
GET	`/api/activities/reports`	Отчёты по активностям	`usersId`: array[long] — обязательно: да `startDate`: string — обязательно: нет `endDate`: string — обязательно: нет
GET	`/api/activities/searches`	Поисковые запросы пользователей	`usersId`: array[long] — обязательно: да `startDate`: string — обязательно: нет `endDate`: string —обязательно: нет
GET	`/api/activities/keylogger`	Данные кейлоггера	`usersId`: array[long] — обязательно: да

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

Создание отдела

fetch(`${url}/api/departments/save?key=${key}`, { method:'POST', body: formData })

Создание пользователя

fetch(`${url}/api/users/save`, { method:'POST', headers:{authorization: API_KEY,'Content-Type':'application/json'}, body: JSON.stringify({...}) })

Получение и отображение скриншота

const { data } = await fetch(`${url}/api/activities/find?${params}`).then(r=>r.json());

const screenshotId = JSON.parse(data.data).file;