TemplioniX (предварительная версия)
TemplioniX — это API создания документов для создания ФАЙЛОВ DOCX и PDF из повторно используемых шаблонов Word. Используйте этот соединитель для извлечения метаданных шаблона, создания одного документа, запуска массового создания документов, проверки состояния массового задания, скачивания результатов и просмотра сведений о подписке или использовании.
Проверка подлинности выполняется с использованием переданного ключа API.
Созданные ссылки на массовое скачивание ZIP действительны в течение 24 часов.
Этот соединитель доступен в следующих продуктах и регионах:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Все регионы Power Automate за исключением следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Standard | Все регионы Logic Apps , кроме следующих: - Azure для государственных организаций регионы - Azure регионы Китая - Министерство обороны США (DoD) |
| Power Apps | Premium | Все регионы Power Apps кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Premium | Все регионы Power Automate за исключением следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Contact | |
|---|---|
| Name | Поддержка TemplioniX |
| URL | https://templionix.com |
| Адрес электронной почты | support@templionix.com |
| Метаданные соединителя | |
|---|---|
| Publisher | TemplioniX |
| Веб-сайт | https://templionix.com |
| Политика конфиденциальности | https://templionix.com/privacy-policy |
| Условия использования | https://templionix.com/terms-of-use |
| Categories | Продуктивность; Содержимое и файлы |
| IconBrandColor | #333A41 |
Соединитель TemplioniX
Общие сведения
TemplioniX — это служба создания документов, которая помогает создавать ФАЙЛЫ DOCX и PDF из повторно используемых шаблонов Microsoft Word и структурированных данных JSON.
Этот соединитель позволяет пользователям подключать Microsoft Power Automate, Power Apps, Azure Logic Apps и Copilot Studio рабочие процессы к API TemplioniX. Пользователи могут извлекать метаданные шаблона, создавать полезные данные JSON starter, создавать документы, запускать задания массового создания документов, проверять состояние задания, скачать созданные результаты и получить доступные шаблоны.
Publisher
TemplioniX
Предполагаемые Microsoft продукты
- Microsoft Power Automate (Майкрософт Пауэр Автомат)
Соединитель реализуется как Microsoft Power Platform настраиваемый соединитель и может использоваться в других Microsoft соединителях, где поддерживаются сертифицированные соединители.
Аутентификация
Соединитель использует проверку подлинности ключа API. Ключ API передается в заголовке x-functions-key запроса.
У пользователей должна быть активная учетная запись TemplioniX и действительный ключ API для использования этого соединителя.
Основные возможности
Получение шаблонов
Извлекает список доступных шаблонов документов с разбивкой на страницы из TemplioniX. Эту операцию можно использовать для выбора шаблона перед созданием метаданных, начальной моделью, одним документом или заданием массового создания документов.
Извлечение полей шаблона и заполнителей
Извлекает метаданные из выбранного шаблона, включая поля шаблона и заполнители. Это помогает пользователям понять, какие данные ожидаются шаблоном.
Создание начальной полезных данных JSON для шаблона
Создает пример полезных данных JSON на основе выбранного шаблона. Пользователи могут использовать эту полезные данные в качестве отправной точки для сопоставления данных из других систем в запрос на создание документов.
Создание документа
Создает документ DOCX или PDF из выбранного шаблона и входных данных JSON.
Создание документов в массовом режиме
Запускает задание массового создания документов с помощью выбранного шаблона и нескольких входных записей. Созданные ссылки на массовое скачивание ZIP действительны в течение 24 часов.
Получение состояния задания массового создания
Извлекает сведения о состоянии и результатах для определенного задания массового создания документов.
Получение заданий массового создания по шаблону
Извлекает задания массового создания, связанные с выбранным шаблоном.
Распространенные сценарии использования
- Создайте контракты, счета, предложения, отчеты, письма и другие бизнес-документы из структурированных данных.
- Автоматизация создания документов из CRM, ERP, форм, Excel, SharePoint, Dataverse, SQL или систем на основе API.
- Создание отдельных документов по запросу из рабочего процесса.
- Создайте несколько документов в массовом режиме и получите созданный ZIP-результат.
- Используйте извлеченные метаданные шаблона, чтобы понять, какие поля необходимы для создания документов.
Пример рабочего процесса
- Активируйте поток вручную или из бизнес-события.
- Используйте операцию "Получить шаблоны" для выбора шаблона.
- Используйте операцию создания начальной полезных данных JSON для понимания ожидаемой структуры данных.
- Сопоставляйте исходные данные системы с созданной структурой JSON.
- Используйте операцию создания документа для создания DOCX или PDF-файла.
- Сохраните созданный файл для OneDrive, SharePoint, Dataverse, электронной почты или другого назначения.
Support
Сведения о продукте, документации и поддержке:
- Сайт: https://templionix.com
- Документация: https://docs.templionix.com
- Поддержка: https://templionix.com/contact
- Конфиденциальности: https://templionix.com/privacy-policy
- Условия использования: https://templionix.com/terms-of-use
Заметки о проверке сертификации
Этот пакет содержит решение соединителя TemplioniX и пример решения потока, демонстрирующего операции соединителя. Соединитель взаимодействует с рабочим API TemplioniX и использует проверку подлинности ключа API через x-functions-key заголовок.
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Name | Type | Description | Обязательный |
|---|---|---|---|
| Ключ API TemplioniX | securestring | Ключ API TemplioniX для этого API | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Вывод списка заданий массового создания для шаблона |
Возвращает все задания для секции массового создания, в которой соответствует TemplateId; та же фигура полезных данных, что и состояние одного задания, отсортированная по убыванию времени начала |
| Запуск массового создания документов |
Запустите массовое задание для создания документов из общего шаблона, создает ZIP-файл с url-адресом SAS для чтения и отслеживает ход выполнения. Возвращает идентификатор задания немедленно. Возвращенный URL-адрес загрузки ZIP доступен после завершения задания и действителен в течение 24 часов с момента создания. |
| Извлечение полей шаблона и заполнителей |
Считывает выбранный шаблон и возвращает элементы управления содержимым, обнаруженные в документе, включая их название, тег, тип и предопределенные значения при наличии. |
| Получение состояния задания массового создания |
Загружает состояние задания по идентификатору: состояние, время начала и окончания, URL-адрес ZIP SAS при завершении, ошибку оркестрации при сбое и синтаксический анализ сбоев создания элементов. |
| Создание документа из данных шаблона |
Объединяет предоставленные полезные данные JSON с выбранным шаблоном и возвращает созданный документ. Использование |
| Создание начальной полезных данных JSON для шаблона |
Создает пример структуры JSON, которая соответствует заполнителям, обнаруженным в выбранном шаблоне, чтобы его можно было повторно использовать в качестве входных данных для создания документов. |
| Список доступных шаблонов |
Возвращает список шаблонов с разбивкой на страницы, которые можно использовать с извлечением метаданных, созданием моделей и конечными точками создания документов |
Вывод списка заданий массового создания для шаблона
Возвращает все задания для секции массового создания, в которой соответствует TemplateId; та же фигура полезных данных, что и состояние одного задания, отсортированная по убыванию времени начала
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор шаблона
|
templateId | True | uuid |
Возвращаются только задания, запущенные с идентификатором шаблона. |
Возвращаемое значение
- response
- array of bulkGenerationJobStatusDto
Запуск массового создания документов
Запустите массовое задание для создания документов из общего шаблона, создает ZIP-файл с url-адресом SAS для чтения и отслеживает ход выполнения. Возвращает идентификатор задания немедленно. Возвращенный URL-адрес загрузки ZIP доступен после завершения задания и действителен в течение 24 часов с момента создания.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Template
|
templateId | uuid |
Уникальный идентификатор шаблона |
|
|
Формат
|
format | string |
Формат вывода. Использование .docx для документов Word или .pdf для PDF-документов |
|
|
Имя файла
|
fileName | string |
Созданное или запрошенное имя файла |
|
|
items
|
items | object |
Возвращаемое значение
Ответ, возвращаемый при принятии задания массового создания документов для обработки.
Извлечение полей шаблона и заполнителей
Считывает выбранный шаблон и возвращает элементы управления содержимым, обнаруженные в документе, включая их название, тег, тип и предопределенные значения при наличии.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор шаблона
|
templateId | True | uuid |
Уникальный идентификатор шаблона, возвращаемый каталогом шаблонов |
Возвращаемое значение
- response
- array of contentControlInfoDto
Получение состояния задания массового создания
Загружает состояние задания по идентификатору: состояние, время начала и окончания, URL-адрес ZIP SAS при завершении, ошибку оркестрации при сбое и синтаксический анализ сбоев создания элементов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор массового задания
|
jobId | True | string |
Идентификатор задания, возвращенный в ответе generateDocumentsBulk 202 ( |
Возвращаемое значение
Сведения о состоянии и результатах задания массового создания документов.
Создание документа из данных шаблона
Объединяет предоставленные полезные данные JSON с выбранным шаблоном и возвращает созданный документ. Использование .docx Word выходных данных или .pdf выходных данных PDF
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Template
|
templateId | uuid |
Уникальный идентификатор шаблона |
|
|
data
|
data | object |
Объект JSON, содержащий значения для заполнителей шаблона. |
|
|
Имя документа
|
documentName | string |
Имя созданного документа без расширения, если API не принимает расширение. |
|
|
Формат
|
format | string |
Формат вывода. Используйте .docx для документов Word или .pdf для PDF-документов. |
Возвращаемое значение
- response
- file
Создание начальной полезных данных JSON для шаблона
Создает пример структуры JSON, которая соответствует заполнителям, обнаруженным в выбранном шаблоне, чтобы его можно было повторно использовать в качестве входных данных для создания документов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор шаблона
|
templateId | True | uuid |
Уникальный идентификатор шаблона, возвращаемый каталогом шаблонов |
Возвращаемое значение
- response
- object
Список доступных шаблонов
Возвращает список шаблонов с разбивкой на страницы, которые можно использовать с извлечением метаданных, созданием моделей и конечными точками создания документов
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер страницы
|
pageNumber | True | integer |
1-й индекс страницы для возврата |
|
Размер страницы
|
pageSize | True | integer |
Максимальное количество шаблонов, возвращаемых в одном ответе |
Возвращаемое значение
Ответ на основе смещений, содержащий записи шаблона.
Определения
bulkGenerationAcceptedDto
Ответ, возвращаемый при принятии задания массового создания документов для обработки.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор задания
|
jobId | string |
Уникальный идентификатор задания массового создания. |
|
Начато в
|
startedAt | date-time |
Дата и время начала операции в формате UTC. |
bulkGenerationFailureItemDto
Сведения о одном элементе документа сбоем в задании массового создания.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Глобальный индекс
|
globalIndex | string |
Индекс или внутренний идентификатор сбой созданного элемента. |
|
Имя файла
|
fileName | string |
Созданное или запрошенное имя файла. |
|
Ошибка
|
error | string |
Сообщение об ошибке для неудачного элемента. |
bulkGenerationJobStatusDto
Сведения о состоянии и результатах задания массового создания документов.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор задания
|
jobId | string |
Уникальный идентификатор задания массового создания. |
|
ИД шаблона
|
templateId | uuid |
Уникальный идентификатор шаблона. |
|
Статус
|
status | string |
Текущее состояние задания, например ожидание, выполнение, завершено, сбой или частично завершено. |
|
Начато в
|
startedAt | date-time |
Дата и время начала операции в формате UTC. |
|
Время окончания
|
endTime | date-time |
Дата и время выполнения задания в формате UTC. |
|
URL-адрес zip
|
zipUrl | string |
URL-адрес временного скачивания для созданного ZIP-файла. Для массового создания эта ссылка действительна в течение 24 часов с момента создания. |
|
Сообщение об ошибке
|
errorMessage | string |
Сообщение об ошибке уровня задания, если оркестрация завершилась ошибкой. |
|
Неудачные генерации
|
failedGenerations | array of bulkGenerationFailureItemDto |
Коллекция неудачных элементов внутри задания массового создания. |
|
Число неудачных поколений
|
failedGenerationCount | integer |
Количество неудачных элементов в задании массового создания. |
categoryDto
Сведения о категории шаблона.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | uuid |
Уникальный идентификатор. |
|
name
|
name | string |
Отображаемое имя. |
contentControlInfoDto
Метаданные для одного элемента управления содержимым Word или заполнителя, обнаруженные в шаблоне.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
заголовок
|
title | string |
Заголовок элемента управления содержимым. |
|
tag
|
tag | string |
Тег элемента управления содержимым, используемый в качестве ключа поля JSON. |
|
type
|
type | string |
Тип элемента управления содержимым. |
pagedResponseOffsetDto_templateInfoDto
Ответ на основе смещений, содержащий записи шаблона.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
data
|
data | array of templateInfoDto |
Объект JSON, содержащий значения для заполнителей шаблона. |
|
Номер страницы
|
pageNumber | integer |
Текущий номер страницы. |
|
Размер страницы
|
pageSize | integer |
Количество записей на страницу. |
|
Всего записей
|
totalRecords | integer |
Общее количество доступных записей. |
|
Всего страниц
|
totalPages | integer |
Общее количество страниц. |
templateInfoDto
Элемент каталога шаблонов, возвращаемый конечной точкой списка шаблонов.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | uuid |
Уникальный идентификатор. |
|
Name
|
name | string |
Отображаемое имя. |
|
Description
|
description | string |
Описание, доступное для чтения человеком. |
|
Создано
|
createdOn | date-time |
Дата и время создания шаблона в формате UTC. |
|
Последнее изменение
|
lastModified | date-time |
Дата и время последнего изменения шаблона в формате UTC. |
|
categories
|
categories | array of categoryDto |
Категории шаблонов. |
file
Это базовый тип данных file.
object
Это тип «объект».