smarty-mediaДата актуальности: 2026-06-18. Read-only документация.
Справочник REST-эндпоинтов, экспонируемых роутамиsmarty-backend-stable/smarty-media/routes/.
Все маршруты подключены под префиксом /api/v2 (значение config.rest.api). Внутренние роуты монтируются через Router('/ws/:_wsId'), итого полный путь:
/api/v2/ws/:_wsId + basePath роутера + path createRoute
| Класс запроса | Описание |
|---|---|
AuthRequest |
Авторизованная сессия (cookie/token). |
ObjectInstanceRequest |
Доступ к объекту в workspace (employee). |
ObjectInstanceRequestNoEmployee |
Доступ к объекту без employee (для РП, пользователей). |
BasicRequest |
Базовая авторизация (ссылки для скачивания). |
| Роутер | Файл | Описание |
|---|---|---|
ocr |
ocr.js |
OCR-обработка изображений |
fs |
fs.js |
Файловое хранилище (FileStorage) |
catalogs |
catalogs.js |
Каталоги файлов |
files |
files.js |
Загрузка и управление файлами |
attaches |
attaches.js |
Прикреплённые объекты |
newsFilesRouter |
news.js |
Файлы новостей |
avatarRouter |
avatars.js |
Аватарки объектов |
shortLinkRouter |
index.js |
Одноразовые ссылки для скачивания |
fs.js)Модель: FileStorage
Базовый путь: /api/v2/ws/:_wsId/filestorage/... (WorkspaceObject)
Стандартные CRUD-эндпоинты.
catalogs.js)Базовый путь: /api/v2/ws/:_wsId/... (WorkspaceObject)
Стандартные CRUD-эндпоинты для каталогов.
files.js)Базовый путь: /api/v2/ws/:_wsId/... (WorkspaceObject)
Стандартные CRUD-эндпоинты для файлов. Поддержка загрузки, квот, проверки MIME-типов.
attaches.js)Модель: Attaches
Базовый путь: /api/v2/attaches/... (RegularObject, не-scoped к workspace)
Стандартные эндпоинты. Не привязаны к workspace через URL, но проверяют доступ через ObjectInstanceRequestNoEmployee.
news.js)Базовый путь: /api/v2/files/news/:_id
Описание: "Файлы новостей"
Через urlBinder привязывает стандартные файловые эндпоинты (скачивание, просмотр) к объектам NewsFile.
avatars.js)Базовый путь: /api/v2/avatar
Описание: "Аватарки"
Аватарки монтируются для каждого типа объектов, поддерживающих ObjectWithAvatar:
| Путь | Описание |
|---|---|
/avatar/ws/:_id |
Аватарка рабочего пространства |
/avatar/users/:_id |
Аватарка пользователя |
/avatar/me |
Аватарка текущего пользователя |
/avatar/ws/:_wsId/:collectionName/:_id |
Аватарка объекта (employees, contacts, etc.) |
/avatar/attaches/:_id |
Аватарка прикреплённого объекта |
| Метод | Путь | Auth | Назначение |
|---|---|---|---|
GET |
.../download |
Auth | Скачивание оригинала (redirect) |
GET |
.../view |
Auth | Прямая ссылка на оригинал (без скачивания) |
GET |
.../url |
Auth | Прямая ссылка на оригинал |
GET |
.../:size |
Auth | Аватарка заданного размера (redirect) |
GET |
.../url/:size |
Auth | Ссылка на аватарку заданного размера |
GET |
.../preview/:size |
Auth | Предпросмотр размера оригинала (redirect) |
GET |
.../preview_url/:size |
Auth | Ссылка на предпросмотр размера оригинала |
| Метод | Путь | Auth | Назначение | Параметры |
|---|---|---|---|---|
POST |
.../ |
Auth (multipart) | Загрузка аватарки | file upload |
POST |
.../object |
Auth | Копирование из другого объекта | body: collectionName, _id, crop-параметры |
POST |
.../file |
Auth | Установка из ранее загруженного файла | body: file (ObjectId), crop-параметры |
| Метод | Путь | Auth | Назначение | Параметры |
|---|---|---|---|---|
POST |
.../crop |
Auth | Кадрирование аватарки | body: crop-параметры |
DELETE |
.../ |
Auth | Удаление аватарки | -- |
index.js)Базовый путь: /api/v2/files
| Метод | Путь | Auth | Назначение | Параметры |
|---|---|---|---|---|
GET |
/files/:_id/:token/download |
Basic | Скачивание файла по одноразовой ссылке | path: _id (ObjectId), token |
Примечание: перенаправляет (redirect) на файл после валидации токена.