Справка, Синтаксис и API Документация

Полное руководство по разметке Word-шаблонов (.docx), генерации документов через REST API и интеграции с CRM (Bitrix24, amoCRM, Make, n8n).

Правила разметки шаблонов Microsoft Word (.docx)

Как правильно создавать переменные, ветвления, циклы и картинки в документе

1

Текстовые и числовые переменные

Оборачивайте имена переменных в двойные фигурные скобки {{имя_поля}}'.

В документе Word
Договор № {{contract_num}}
Клиент: {{client_name}}
Сумма: {{total_price}} руб.
JSON-данные для подстановки
{
  "contract_num": "458/26",
  "client_name": "ООО Вектор",
  "total_price": 150000
}
Результат в готовом файле
Договор № 458/26
Клиент: ООО Вектор
Сумма: 150000 руб.
2

Условные блоки (If / Else)

Показывайте или скрывайте фрагменты текста, оговорки и параграфы в зависимости от флагов true/false.

В документе Word
{{#if has_discount}}
Скидка: {{discount}}%
{{/if}}
{{^has_discount}}
Без скидки
{{/has_discount}}
JSON-данные для подстановки
{
  "has_discount": true,
  "discount": 10
}
Результат в готовом файле
Скидка: 10%

(Блок без скидки скрывается полностью)

3

Таблицы, списки и циклы

Автоматическое дублирование строк таблицы Word для каждого элемента массива данных.

В таблице Word
УслугаЦена
{{#items}}{{title}}{{price}}{{/items}}

Word автоматически создаст новую строку на каждый элемент массива!

JSON-данные для подстановки
{
  "items": [
    { "title": "Дизайн", "price": 40000 },
    { "title": "Разработка", "price": 110000 }
  ]
}
Результат в готовом файле
УслугаЦена
Дизайн40000
Разработка110000
4

Изображения, логотипы, подписи и печати

Вставляйте картинки в Word и управляйте ими через замещающий текст (Alt Text).

Как вставить картинку по шагам:

Шаг 1: Вставка в Word

Вставьте любую картинку-заглушку в документ и настройте ее размер (ширину и высоту).

Шаг 2: Alt-Text (Замещающий текст)

Нажмите правой кнопкой по картинке ➔ «Формат рисунка»«Замещающий текст» (Alt Text) и укажите название переменной: {{logo}}.

Шаг 3: Передача данных

В API передайте Base64-строку data:image/png;base64,... или прямой HTTP-URL картинки.