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

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

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

Рабочие разделы

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

Какие заголовки нужны для внешних и административных запросов, где использовать X-Api-Key, а где X-Admin-Token.

Таблицы в v2

Как передавать строковые данные для таблиц через rows.*, как сервис понимает количество строк и что делать со значениями, в которых есть запятые.

Page slug в v2

Как работает page_slug, когда его передавать, какие ограничения у значения и что делает сервис, если slug не был указан.

Ответы и ошибки v2

Какие ответы считаются штатными, какие коды ошибок уже используются в v2 и как их правильно интерпретировать интегратору.

Общая логика сервиса

Что в VARICA считается шаблоном, что считается созданной страницей и как устроен базовый сценарий работы без углубления в API.

Работа с конструктором

Как создавать шаблоны вручную, открывать сохранённые версии, что делает предпросмотр и как понимать сохранённое состояние шаблона.

Импорт PDF и HTML/CSS

Как использовать импорт из действующего КП, что делает PDF-цепочка и когда лучше загружать готовую верстку напрямую.

Изображения, подпись и композиция

Как работать с одиночными изображениями, галереями, типовым блоком подписи и свободной композицией со слоями.

Мобильный вид и типовые проблемы

Как смотреть мобильную версию, что делать с таблицами и что проверить, если предпросмотр или изображения ведут себя не так, как ожидалось.

Переменные и маски

Какие переменные поддерживаются в шаблонах, чем отличаются обычные поля и табличные строки, и как сервис подставляет значения.

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

Как ведут себя созданные страницы, что в них фиксируется, почему они snapshot-версии и какие действия доступны на самой странице.

API v2
Страницы и результат

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

Создаёт публичную страницу по шаблону, принимает обычные поля и табличные строки, возвращает URL и slug страницы.

Обновление результата по сущности

Привязывает внешний результат к уже созданным страницам по source_entity_id и обновляет статус результата у всех связанных страниц.

Webhook

Webhook открытия КП

VARICA отправляет POST JSON на webhook_url организации при каждом открытии публичной страницы КП.