VARICA
digital proposal bureau
VARICA / Документация v2

Подробная документация VARICA v2

Это входной контур документации. Здесь собраны рабочие разделы по продукту, редактору и шаблонам, и отдельные страницы по API v2. На эту страницу можно вести и человека, и ИИ.

Рабочие разделы
API v2
Продукт и редактор

Обзор сервиса

VARICA — сервис для создания, публикации и отслеживания коммерческих предложений в виде персональных веб-страниц.

Публичные страницы и PDF

Клиент открывает одну публичную ссылку. Внешняя оболочка страницы отвечает за:

Маски и данные шаблона

Поддерживается только формат:

Хранение шаблона

Шаблон — редактируемая заготовка КП внутри одной организации. Он хранится в `templates` и содержит как пользовательское содержимое, так и техническое состояние редактора.

Импорт и медиа

В модалке «Создать из КП» можно вставить готовые HTML и CSS. Импорт не должен сразу менять холст: сначала результат становится `pendingImport`, затем пользователь выбирает:

Элементы, секции и слои

Панель настроек должна работать именно по выбранному уровню. Выбранный блок не должен внезапно менять шрифт дочернего текста; для этого выбирается сам текстовый элемент.

Публичные страницы и PDF

Клиент открывает одну публичную ссылку. Внешняя оболочка страницы отвечает за:

API v2

Авторизация API v2

Каждое пространство VARICA имеет постоянный API-ключ. Его владелец видит в разделе «Настройки» кабинета. Внешняя система передаёт его в заголовке:

Создание страницы КП

POST https://varica.ru/api/v2/pages

Табличные строки в API v2

`rows.*` применяется только для масок вида `{{tables.name}}`, расположенных в Table v2. Пример таблицы шаблона:

Создание страницы КП

POST https://varica.ru/api/v2/pages

Результат по исходной сущности

POST https://varica.ru/api/v2/entity-results

Webhook открытия страницы

Если в настройках пространства задан `webhook_url`, VARICA отправляет HTTP POST после каждого открытия публичного КП. Это позволяет CRM или внешнему BPMN-сценарию отреагировать на интерес клиента.

Ошибки и повторные запросы API v2

Пример:

Потоки запросов

sequenceDiagram