Шаблоны

Документ создаётся из шаблона — или из готового файла, если он у вас уже есть: см. Загрузка своего документа. Шаблон задаёт печатную форму и набор переменных, которые заполняются при создании документа. Эти переменные описаны в variable_schema — JSON-схеме, которой должен соответствовать template_values в теле POST /documents. Порядок работы простой: найдите шаблон → прочитайте его variable_schema → подготовьте template_values по этой схеме. Всё чтение шаблонов покрывает область documents:read.

Поиск шаблонов

GET /document_templates возвращает только активные шаблоны, постранично. Сузьте выборку параметром search по названию:

curl -H "X-API-Key: ddp_ВАШ_КЛЮЧ" \
  "https://app.doodocs.kz/api/developer/v1/document_templates?search=%D0%BF%D1%80%D0%B8%D1%91%D0%BC&limit=20"

{
  "templates": [
    {
      "id": "tpl_7c1a…",
      "name": "Приказ о приёме на работу",
      "version": 3
    }
  ],
  "next_page_token": ""
}

Список подчиняется общей пагинации: limit (по умолчанию 100, максимум 1000) и непрозрачный page_token. Неактивные шаблоны через Developer API не отдаются.

Чтение схемы переменных

GET /document_templates/{template_id} возвращает шаблон вместе с variable_schema:

curl -H "X-API-Key: ddp_ВАШ_КЛЮЧ" \
  https://app.doodocs.kz/api/developer/v1/document_templates/tpl_7c1a…

{
  "id": "tpl_7c1a…",
  "name": "Приказ о приёме на работу",
  "version": 3,
  "variable_schema": {
    "type": "object",
    "required": ["employee_full_name", "position", "start_date"],
    "properties": {
      "employee_full_name": { "type": "string", "title": "ФИО сотрудника" },
      "position":           { "type": "string", "title": "Должность" },
      "start_date":         { "type": "string", "format": "date", "title": "Дата приёма" },
      "salary":             { "type": "number", "title": "Оклад" }
    }
  }
}

Состав variable_schema зависит от конкретного шаблона — читайте его перед созданием документа, а не полагайтесь на память. Для «Приказа о приёме на работу» из примера template_values собирается по трём обязательным полям:

{
  "template_values": {
    "employee_full_name": "Куляш Байсеитова",
    "position": "HR-менеджер",
    "start_date": "2026-02-10",
    "salary": 650000
  }
}

Закрепляйте версию шаблона: передавайте template_version в POST /documents равным version из ответа. Так документ создаётся по той схеме, которую вы читали, даже если шаблон позже обновят.

Если template_values не соответствует variable_schema шаблона (нет обязательного поля, неверный тип), POST /documents вернёт 400. Сверяйте значения со схемой до отправки.

Дальше

Подписание

Создайте документ из шаблона и проведите его по маршруту.

Обзор документов

Статусы, структура объекта и файлы.

Начало работы

Сотрудники

Документы

Рецепты

Поиск шаблонов

Чтение схемы переменных

Дальше

Подписание

Обзор документов

​Поиск шаблонов

​Чтение схемы переменных

​Дальше

Подписание

Обзор документов

Поиск шаблонов

Чтение схемы переменных

Дальше