Documentation, Syntax & API Reference

Complete guide for Word template markup (.docx), document generation via REST API, and CRM integrations (Bitrix24, amoCRM, Make, n8n).

Microsoft Word (.docx) Template Rules

How to structure variables, conditional clauses, dynamic tables, and images

Wrap variable names in double curly braces {{field_name}}.

In Word Document

Договор № {{contract_num}}
Клиент: {{client_name}}
Сумма: {{total_price}} руб.

JSON Payload

{
  "contract_num": "458/26",
  "client_name": "ООО Вектор",
  "total_price": 150000
}

Compiled Output

Договор № 458/26
Клиент: ООО Вектор
Сумма: 150000 руб.

Show or hide sections, clauses, or paragraphs dynamically based on true/false flags.

In Word Document

{{#if has_discount}}
Скидка: {{discount}}%
{{/if}}
{{^has_discount}}
Без скидки
{{/has_discount}}

JSON Payload

{
  "has_discount": true,
  "discount": 10
}

Compiled Output

Скидка: 10%

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

Automatically replicate rows in a Word table for each record in an array.

In Word Table

Услуга	Цена
{{#items}}{{title}}	{{price}}{{/items}}

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

JSON Payload

{
  "items": [
    { "title": "Дизайн", "price": 40000 },
    { "title": "Разработка", "price": 110000 }
  ]
}

Compiled Output

Услуга	Цена
Дизайн	40000
Разработка	110000

Insert placeholder images in Word and link them via Alt Text descriptions.

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

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

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

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

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

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