REST API

TemplioniX надає методи пошуку шаблонів, отримання метаданих, формування одного документа та асинхронного пакетного формування.

До кожного запиту додавайте дійсний заголовок x-functions-key.

Основні методи

• GET /api/getTemplates?pageNumber={n}&pageSize={n} — список шаблонів.
• GET /api/generateTemplateMetadata?templateId={guid} — розпізнані поля.
• POST /api/generateModel?templateId={guid} — початковий JSON.
• POST /api/generateDocument — один файл DOCX або PDF.

Пакетне формування

Запустіть завдання:

POST /api/generateDocumentsBulk
x-functions-key: your_api_key
Content-Type: application/json

Приклад:

{
  "templateId": "00000000-0000-0000-0000-000000000000",
  "format": ".pdf",
  "fileName": "Invoice_{{invoiceNumber}}_{{customerName}}.",
  "items": [
    {
      "invoiceNumber": "INV-1001",
      "customerName": "Northwind"
    },
    {
      "invoiceNumber": "INV-1002",
      "customerName": "Contoso"
    }
  ]
}

Метод повертає 202 Accepted, jobId і startedAt.

Для перевірки використовуйте:

• GET /api/bulkGenerationJobs/{jobId} — стан одного завдання;
• GET /api/bulkGenerationJobs/byTemplate/{templateId} — завдання конкретного шаблону.

Завершене завдання містить тимчасовий URL ZIP-архіву. Відповідь також може містити помилку оркестрації та невдалі окремі елементи. Обмеження залежать від конфігурації сервера й активної підписки.

Відповіді та помилки

• Метадані, моделі, списки та стани повертаються як JSON.
• Одиночне формування повертає бінарний файл.
• Некоректні дані повертають 400.
• Відсутній або недійсний ключ повертає 401.
• Невідоме пакетне завдання повертає 404.

Повні схеми й приклади доступні в Довіднику API.