Шаблоны
REST API раздела «Шаблоны»: 78 операций.
Базовый адрес: https://api.legalstack.ru. Спецификация: openapi/smartdoc.json.
AI-инструменты
AI-функции при работе с текстом шаблона.
Совместное редактирование
Совместное редактирование шаблонов в реальном времени.
Шаблоны и блоки
Создание шаблонов и управление их блоками.
Папки
Папки шаблонов.
Импорт и экспорт
Импорт шаблонов из DOCX, PDF и HTML, экспорт в DOCX и PDF.
Связи с реестрами
Связи шаблонов с записями реестров.
Типы блоков и роли сторон
Типы блоков и роли сторон по типам договоров.
Доступ и приглашения
Доступ к шаблонам и приглашения.
Операции
Всего операций: 78. У каждой операции своя страница со схемами запроса и ответа и примерами вызова.
AI-инструменты
| Метод | Путь | Операция |
|---|---|---|
POST | /api/v1/smartdoc/ai/transform | ИИ-обработка текста |
Совместное редактирование
| Метод | Путь | Операция |
|---|---|---|
POST | /api/v1/smartdoc/documents/{id}/comments/notify | Уведомить участников о новом комментарии к шаблону |
GET | /api/v1/smartdoc/documents/{id}/yjs | Получить состояние шаблона для совместного редактирования (Yjs CRDT, бинарный формат) |
Шаблоны и блоки
| Метод | Путь | Операция |
|---|---|---|
POST | /api/v1/smartdoc/blocks/batch | Получить блоки по списку id |
POST | /api/v1/smartdoc/blocks/parent-documents | Родительские шаблоны для блоков |
GET | /api/v1/smartdoc/blocks/{blockId} | Получить блок по id |
GET | /api/v1/smartdoc/blocks/{blockId}/references | Ссылки на блок из других шаблонов |
POST | /api/v1/smartdoc/decline-name | Просклонять ФИО по падежам |
POST | /api/v1/smartdoc/decline-role | Просклонять роль стороны по падежам |
GET | /api/v1/smartdoc/documents | Список шаблонов |
POST | /api/v1/smartdoc/documents | Создать шаблон |
POST | /api/v1/smartdoc/documents/from-template | Создать шаблон из библиотеки |
DELETE | /api/v1/smartdoc/documents/{id} | Удалить шаблон |
GET | /api/v1/smartdoc/documents/{id} | Получить шаблон |
PUT | /api/v1/smartdoc/documents/{id} | Обновить шаблон |
POST | /api/v1/smartdoc/documents/{id}/blocks | Добавить блок в шаблон |
DELETE | /api/v1/smartdoc/documents/{id}/blocks/{blockId} | Удалить блок шаблона |
PATCH | /api/v1/smartdoc/documents/{id}/blocks/{blockId} | Обновить блок шаблона |
POST | /api/v1/smartdoc/documents/{id}/copy | Копировать шаблон |
POST | /api/v1/smartdoc/documents/{id}/link | Связать дочерний шаблон |
PATCH | /api/v1/smartdoc/documents/{id}/move | Переместить шаблон в папку |
POST | /api/v1/smartdoc/documents/{id}/project-now | Применить накопленные правки совместного редактирования к блокам |
POST | /api/v1/smartdoc/documents/{id}/restore/{versionId} | Восстановить шаблон из версии |
POST | /api/v1/smartdoc/documents/{id}/save | Сохранить шаблон целиком |
GET | /api/v1/smartdoc/documents/{id}/suggestions | Нерассмотренные предложения агента |
POST | /api/v1/smartdoc/documents/{id}/suggestions/resolve-all | Принять или отклонить все предложения агента |
POST | /api/v1/smartdoc/documents/{id}/suggestions/{suggestionId}/accept | Принять предложение агента |
POST | /api/v1/smartdoc/documents/{id}/suggestions/{suggestionId}/reject | Отклонить предложение агента |
POST | /api/v1/smartdoc/documents/{id}/unlink | Отвязать дочерний шаблон |
GET | /api/v1/smartdoc/documents/{id}/versions | Версии шаблона |
POST | /api/v1/smartdoc/documents/{id}/versions | Создать версию шаблона |
GET | /api/v1/smartdoc/documents/{id}/versions/compare | Сравнить две версии шаблона |
GET | /api/v1/smartdoc/documents/{id}/versions/{versionId} | Получить версию шаблона |
GET | /api/v1/smartdoc/documents/{id}/versions/{versionId}/compare-current | Сравнить версию с текущим состоянием |
GET | /api/v1/smartdoc/parties/{recordId}/documents | Шаблоны с участием контрагента |
POST | /api/v1/smartdoc/resync | Пересинхронизировать шаблоны команды |
Папки
| Метод | Путь | Операция |
|---|---|---|
GET | /api/v1/smartdoc/folders | Список папок |
POST | /api/v1/smartdoc/folders | Создать папку |
DELETE | /api/v1/smartdoc/folders/{id} | Удалить папку |
GET | /api/v1/smartdoc/folders/{id} | Получить папку |
PUT | /api/v1/smartdoc/folders/{id} | Обновить папку |
PATCH | /api/v1/smartdoc/folders/{id}/move | Переместить папку |
Импорт и экспорт
| Метод | Путь | Операция |
|---|---|---|
POST | /api/v1/smartdoc/analyze-file | Проанализировать файл перед импортом |
GET | /api/v1/smartdoc/documents/{id}/export/docx | Экспорт шаблона в DOCX |
GET | /api/v1/smartdoc/documents/{id}/export/pdf | Экспорт шаблона в PDF (скачивание) |
POST | /api/v1/smartdoc/documents/{id}/export/pdf | Экспорт шаблона в PDF (просмотр, с фирменным бланком) |
POST | /api/v1/smartdoc/extraction/warm | Подготовить извлечение текста, пока пользователь выбирает файл для импорта |
POST | /api/v1/smartdoc/import | Импортировать шаблон из файла (PDF/DOCX) |
POST | /api/v1/smartdoc/import/html | Импортировать шаблон из HTML |
POST | /api/v1/smartdoc/import/{jobId}/cancel | Остановить импорт |
GET | /api/v1/smartdoc/import/{jobId}/status | Статус задачи импорта |
Связи с реестрами
| Метод | Путь | Операция |
|---|---|---|
GET | /api/v1/smartdoc/documents/{documentId}/links | Связи шаблона с записями реестров |
POST | /api/v1/smartdoc/documents/{documentId}/links | Привязать запись реестра к шаблону |
DELETE | /api/v1/smartdoc/documents/{documentId}/links/{linkId} | Удалить связь шаблона |
GET | /api/v1/smartdoc/documents/{documentId}/sources | Разрешённые источники документа |
GET | /api/v1/smartdoc/documents/{documentId}/sources/content | Разрешённые данные источников для редактора |
PATCH | /api/v1/smartdoc/documents/{documentId}/sources/variables | Изменить поля используемого источника |
PUT | /api/v1/smartdoc/documents/{documentId}/sources/{id} | Разрешить использование источника в документе |
POST | /api/v1/smartdoc/documents/{documentId}/sources/{id}/revoke | Отозвать конкретное разрешение на источник |
GET | /api/v1/smartdoc/registry/{typeId}/records/{recordId}/documents | Шаблоны, привязанные к записи реестра |
GET | /api/v1/smartdoc/sources/{kind}/{id}/grants | Документы, которым разрешён источник |
Типы блоков и роли сторон
| Метод | Путь | Операция |
|---|---|---|
GET | /api/v1/smartdoc/schemas/blocks | Типы блоков шаблона |
GET | /api/v1/smartdoc/schemas/blocks/{type} | Детали типа блока |
GET | /api/v1/smartdoc/schemas/contract-roles | Карта ролей сторон по типам договоров |
GET | /api/v1/smartdoc/schemas/contract-roles/{contractType} | Роли сторон для типа договора |
Доступ и приглашения
| Метод | Путь | Операция |
|---|---|---|
DELETE | /api/v1/smartdoc/documents/{id}/share-invites/{inviteId} | Отменить приглашение к шаблону |
GET | /api/v1/smartdoc/documents/{id}/shares | Доступы к шаблону |
POST | /api/v1/smartdoc/documents/{id}/shares | Выдать доступ к шаблону |
POST | /api/v1/smartdoc/documents/{id}/shares/by-email | Открыть доступ к шаблону по email |
DELETE | /api/v1/smartdoc/documents/{id}/shares/{shareId} | Отозвать доступ к шаблону |
PATCH | /api/v1/smartdoc/documents/{id}/shares/{shareId} | Изменить доступ к шаблону |
DELETE | /api/v1/smartdoc/folders/{id}/share-invites/{inviteId} | Отменить приглашение к папке |
GET | /api/v1/smartdoc/folders/{id}/shares | Доступы к папке |
POST | /api/v1/smartdoc/folders/{id}/shares | Выдать доступ к папке |
POST | /api/v1/smartdoc/folders/{id}/shares/by-email | Расшарить папку по email |
DELETE | /api/v1/smartdoc/folders/{id}/shares/{shareId} | Отозвать доступ к папке |
PATCH | /api/v1/smartdoc/folders/{id}/shares/{shareId} | Изменить доступ к папке |
GET | /api/v1/smartdoc/shared-with-me | Шаблоны и папки, к которым открыт доступ текущему пользователю |