УК «Маяк» API v1 · 0.1.0 · режим оборудования: mock

Состояние: /health · openapi.json · Swagger UI · маршруты под префиксом /api/v1 · заголовок Authorization: Bearer <accessToken>

Служебное 5

GET/healthПроверка живости: база и Redis
GET/inviteСтраница регистрации по приглашению (ссылка из письма, ?token=…)
GET/reset-passwordСтраница установки нового пароля (ссылка из письма, ?token=…)
GET/api/openapi.jsonОписание API в формате OpenAPI 3
GET/api/swaggerИнтерактивная документация Swagger UI

Вход и сессии 10

POST/api/v1/auth/loginВход по email и паролю; при включённом 2FA возвращает challengeToken
POST/api/v1/auth/2fa/verifyВторой шаг входа: код из приложения-аутентификатора
POST/api/v1/auth/refreshОбновление access-токена по refresh-токену (с ротацией)
POST/api/v1/auth/logoutВыход из текущей сессии; deviceToken — отвязать push-токен устройства
POST/api/v1/auth/logout-allВыход на всех устройствах (push-токены удаляются)
POST/api/v1/auth/forgot-passwordЗапрос ссылки для восстановления пароля
POST/api/v1/auth/reset-passwordУстановка нового пароля по ссылке
POST/api/v1/auth/change-passwordСмена пароля в профиле
GET/api/v1/auth/invitations/:tokenДанные приглашения по токену из письма
POST/api/v1/auth/accept-invitationРегистрация по приглашению УК

Профиль 10

GET/api/v1/meПрофиль: помещения, настройки уведомлений, мобильный ключ, 2FA
PATCH/api/v1/meИзменить ФИО и телефон
GET/api/v1/me/sessionsАктивные сессии на устройствах
DELETE/api/v1/me/sessions/:idЗавершить сессию
PATCH/api/v1/me/notification-settingsНастройки уведомлений (аварийные не отключаются)
POST/api/v1/me/devicesРегистрация push-токена устройства (FCM)
DELETE/api/v1/me/devices/:tokenУдалить push-токен
POST/api/v1/me/2fa/setupПолучить секрет и otpauth-ссылку для 2FA
POST/api/v1/me/2fa/enableВключить 2FA кодом
POST/api/v1/me/2fa/disableОтключить 2FA (пароль + код)

Помещения 1

GET/api/v1/premisesПомещения жителя; для сотрудников — все с жильцами

Заявки 9

GET/api/v1/ticketsСписок заявок (житель — свои, диспетчер — все, исполнитель — назначенные)
POST/api/v1/ticketsНовая заявка; диспетчер может создать от имени жителя
GET/api/v1/tickets/:idКарточка заявки: таймлайн, переписка, вложения
POST/api/v1/tickets/:id/messagesСообщение в заявку (internal — служебная заметка)
POST/api/v1/tickets/:id/messages/:messageId/attachmentsФайлы к сообщению (multipart, до 5 файлов, только автор сообщения)
PATCH/api/v1/tickets/:idСтатус, исполнитель, приоритет, срок (сотрудники)
POST/api/v1/tickets/:id/cancelОтмена заявки жителем
POST/api/v1/tickets/:id/rateОценка выполненной заявки
POST/api/v1/tickets/:id/attachmentsЗагрузка фото и PDF (multipart, до 5 файлов)

Уведомления 2

GET/api/v1/announcementsУведомления и новости УК для жителя
GET/api/v1/announcements/:idОдно уведомление

Файлы 1

GET/api/v1/files/:idСкачать вложение (только участники и сотрудники)

Домофон, двери, камеры 26

POST/api/v1/me/devicesРегистрация push-токена устройства (FCM)
DELETE/api/v1/me/devices/:tokenУдалить push-токен
GET/api/v1/devicesДвери, панели, считыватели с правами и статусом мобильного ключа
POST/api/v1/doors/:id/openОткрыть дверь (охрана — с обязательной причиной)
GET/api/v1/camerasДоступные камеры по зонам
GET/api/v1/cameras/:idКарточка камеры
GET/api/v1/cameras/:id/stream-tokenКороткоживущий токен видеопотока
GET/api/v1/intercom-callsИстория вызовов домофона
POST/api/v1/intercom-calls/:id/answerПринять вызов
POST/api/v1/intercom-calls/:id/declineОтклонить вызов
POST/api/v1/intercom-calls/:id/endЗавершить разговор
GET/api/v1/guest-passesГостевые пропуска
POST/api/v1/guest-passesСоздать гостевой код
DELETE/api/v1/guest-passes/:idОтозвать пропуск
GET/api/v1/ukey/statusСтатус мобильного ключа BAS-IP UKEY и инструкция
POST/api/v1/ukey/requestЗапросить выдачу мобильного ключа
GET/api/v1/access-eventsСобытия доступа (сотрудники — все, житель — свои)
GET/api/v1/admin/devicesРеестр оборудования
POST/api/v1/admin/devicesДобавить устройство
PATCH/api/v1/admin/devices/:idИзменить устройство
DELETE/api/v1/admin/devices/:idУдалить устройство
GET/api/v1/admin/devices/healthСостояние связи оборудования
PUT/api/v1/admin/users/:id/ukeyСтатус выдачи мобильного ключа
GET/api/v1/admin/access-events/exportЭкспорт событий доступа в CSV
POST/api/v1/admin/intercom-calls/simulateТестовый вызов домофона (режим заглушки, шлёт push)
GET/api/v1/admin/monitoring/cameras

Вебхуки оборудования 2

POST/api/v1/webhooks/bas-ip/eventsВебхук BAS-IP: вызовы (push жителям), открытия, считыватели, связь
POST/api/v1/webhooks/nvr/healthВебхук видеошлюза: состояние камер

Веб-кабинет УК 36

GET/api/v1/admin/usersЖители и сотрудники: поиск по ФИО, почте, телефону, квартире
GET/api/v1/admin/users/:idКарточка пользователя
PATCH/api/v1/admin/users/:idРоль, статус, блокировка, сброс 2FA
POST/api/v1/admin/users/:id/premisesПривязать помещение
DELETE/api/v1/admin/users/:id/premises/:premiseIdОтвязать помещение
POST/api/v1/admin/premisesДобавить помещение
PATCH/api/v1/admin/premises/:idИзменить помещение
POST/api/v1/admin/invitationsПригласить жителя или сотрудника
GET/api/v1/admin/invitationsАктивные приглашения
DELETE/api/v1/admin/invitations/:idОтозвать приглашение
POST/api/v1/admin/announcementsОпубликовать уведомление (push уходит аудитории)
PATCH/api/v1/admin/announcements/:idИзменить уведомление
DELETE/api/v1/admin/announcements/:idСнять уведомление
GET/api/v1/admin/statsСводка для рабочего стола диспетчера
GET/api/v1/admin/auditЖурнал действий
GET/api/v1/admin/devicesРеестр оборудования
POST/api/v1/admin/devicesДобавить устройство
PATCH/api/v1/admin/devices/:idИзменить устройство
DELETE/api/v1/admin/devices/:idУдалить устройство
GET/api/v1/admin/devices/healthСостояние связи оборудования
GET/api/v1/admin/structureСтруктура дома: подъезды, зоны
GET/api/v1/admin/dashboardДашборд веб-кабинета: оборудование, инциденты, заявки за неделю
GET/api/v1/admin/users/:id/accessМатрица доступа пользователя
PUT/api/v1/admin/users/:id/accessСохранить матрицу доступа (явные права добавляются к правилу подъезда)
POST/api/v1/admin/access-grants/bulkМассовая выдача прав по подъезду или зоне
PUT/api/v1/admin/users/:id/ukeyСтатус выдачи мобильного ключа
POST/api/v1/admin/residents/importИмпорт жителей из CSV
GET/api/v1/admin/tickets/exportЭкспорт заявок в CSV
GET/api/v1/admin/audit/exportЭкспорт журнала действий в CSV
GET/api/v1/admin/access-events/exportЭкспорт событий доступа в CSV
GET/api/v1/admin/notifications/:id/deliveryСтатистика доставки уведомления
GET/api/v1/admin/integrationsСводка интеграций BAS-IP, видеошлюза, push, почты
PATCH/api/v1/admin/integrations/:keyНесекретные настройки интеграции
POST/api/v1/admin/intercom-calls/simulateТестовый вызов домофона (режим заглушки, шлёт push)
GET/api/v1/admin/premisesПомещения с жильцами (постранично)
GET/api/v1/admin/monitoring/cameras

Консоль

Войдите, затем выполните запрос. Токен хранится только в этой вкладке.
Профиль: пароль и второй фактор
2FA: …