TemplioniX (预览版)
TemplioniX 是一个文档生成 API,用于从可重用Word模板创建 DOCX 和 PDF 文件。 使用此连接器提取模板元数据、生成单个文档、运行批量文档生成、检查批量作业状态、下载生成的结果,以及查看订阅或使用情况信息。
使用传递的 API 密钥执行身份验证。
生成的批量 ZIP 下载链接有效期为 24 小时。
此连接器在以下产品和区域中可用:
| Service | Class | 区域 |
|---|---|---|
| Copilot Studio | 高级 | 除以下各项外的所有 Power Automate 区域: - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 : - Azure 政府区域 - Azure中国区域 - 美国国防部(DoD) |
| Power Apps | 高级 | 除以下各项外的所有 Power Apps 区域: - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| Power Automate | 高级 | 除以下各项外的所有 Power Automate 区域: - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 联系人 | |
|---|---|
| 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 |
| 类别 | 生产力;内容和文件 |
| IconBrandColor | #333A41 |
TemplioniX 连接器
Overview
TemplioniX 是一项文档生成服务,可帮助从可重用Microsoft Word模板和结构化 JSON 数据创建 DOCX 和 PDF 文件。
此连接器允许用户将Microsoft Power Automate、Power Apps、Azure 逻辑应用和Copilot Studio工作流连接到 TemplioniX API。 用户可以提取模板元数据、生成初学者 JSON 有效负载、生成文档、运行批量文档生成作业、检查作业状态、下载生成的结果以及检索可用的模板。
Publisher
TemplioniX
预期Microsoft产品
- Microsoft Power Automate (自动化软件)
连接器作为Microsoft Power Platform自定义连接器实现,在其他支持认证连接器的 Microsoft连接器体验中可能可用。
Authentication
连接器使用 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、电子邮件或其他目标。
支持
有关产品信息、文档和支持,请访问:
- 网站: https://templionix.com
- 文档: https://docs.templionix.com
- 支持:https://templionix.com/contact
- 隐私策略: https://templionix.com/privacy-policy
- 使用条款: https://templionix.com/terms-of-use
认证评审说明
此包包含 TemplioniX 连接器解决方案和演示连接器操作的示例流解决方案。 连接器与生产 TemplioniX API 通信,并通过 x-functions-key 标头使用 API 密钥身份验证。
正在创建连接
连接器支持以下身份验证类型:
| 默认 | 用于创建连接的参数。 | 所有区域 | 不可共享 |
违约
适用:所有区域
用于创建连接的参数。
这是不可共享的连接。 如果 Power App 与另一个用户共享,系统会提示其他用户显式创建新连接。
| Name | 类型 | Description | 必需 |
|---|---|---|---|
| TemplioniX Api 密钥 | securestring | 此 API 的 TemplioniX Api 密钥 | True |
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 100 | 60 秒 |
操作
| 为模板生成初学者 JSON 有效负载 |
生成与所选模板中发现的占位符匹配的示例 JSON 结构,以便可以重复使用它作为文档生成输入 |
| 从模板数据生成文档 |
将提供的 JSON 有效负载与所选模板合并,并返回生成的文档。 用于 |
| 列出可用的模板 |
返回可用于元数据提取、模型生成和文档生成终结点的模板的分页列表 |
| 列出模板的批量生成作业 |
返回 TemplateId 匹配的大容量生成分区的所有作业;与单个作业状态相同的有效负载形状,按开始时间降序排序 |
| 开始批量文档生成 |
启动批量作业以从共享模板生成文档,生成包含读取 SAS URL 的 ZIP,并跟踪进度。 立即返回作业 ID。 返回的 ZIP 下载 URL 在作业完成后可用,从生成时间起有效期为 24 小时。 |
| 提取模板字段和占位符 |
读取所选模板并返回文档中发现的内容控件,包括其标题、标记、类型和预定义值(如果可用)。 |
| 获取批量生成作业状态 |
按 ID 加载作业状态:状态、开始/结束时间、完成后的 ZIP SAS URL、失败时的业务流程错误,以及按项生成失败进行分析。 |
为模板生成初学者 JSON 有效负载
生成与所选模板中发现的占位符匹配的示例 JSON 结构,以便可以重复使用它作为文档生成输入
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
模板标识符
|
templateId | True | uuid |
模板目录返回的唯一模板标识符 |
返回
- 响应
- object
从模板数据生成文档
将提供的 JSON 有效负载与所选模板合并,并返回生成的文档。 用于.docxWord输出或 .pdf PDF 输出
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
模板
|
templateId | uuid |
唯一模板标识符 |
|
|
数据
|
data | object |
包含模板占位符值的 JSON 对象。 |
|
|
文档名称
|
documentName | string |
除非 API 接受扩展,否则生成的文档的名称(除非 API 接受扩展) |
|
|
Format
|
format | string |
输出格式。 将 .docx 用于Word文档或 PDF 文档的 .pdf。 |
返回
- 响应
- file
列出可用的模板
返回可用于元数据提取、模型生成和文档生成终结点的模板的分页列表
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
页码
|
pageNumber | True | integer |
要返回的基于 1 的页面索引 |
|
页面大小
|
pageSize | True | integer |
单个响应中要返回的最大模板数 |
返回
基于偏移的分页响应,包含模板记录。
列出模板的批量生成作业
返回 TemplateId 匹配的大容量生成分区的所有作业;与单个作业状态相同的有效负载形状,按开始时间降序排序
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
模板标识符
|
templateId | True | uuid |
仅返回使用此模板 ID 启动的作业 |
返回
开始批量文档生成
启动批量作业以从共享模板生成文档,生成包含读取 SAS URL 的 ZIP,并跟踪进度。 立即返回作业 ID。 返回的 ZIP 下载 URL 在作业完成后可用,从生成时间起有效期为 24 小时。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
模板
|
templateId | uuid |
唯一模板标识符 |
|
|
Format
|
format | string |
输出格式。 将 .docx 用于Word文档或 PDF 文档的 .pdf |
|
|
文件名
|
fileName | string |
生成或请求的文件名 |
|
|
items
|
items | object |
返回
当已接受批量文档生成作业进行处理时返回的响应。
提取模板字段和占位符
读取所选模板并返回文档中发现的内容控件,包括其标题、标记、类型和预定义值(如果可用)。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
模板标识符
|
templateId | True | uuid |
模板目录返回的唯一模板标识符 |
返回
获取批量生成作业状态
按 ID 加载作业状态:状态、开始/结束时间、完成后的 ZIP SAS URL、失败时的业务流程错误,以及按项生成失败进行分析。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
批量作业标识符
|
jobId | True | string |
generateDocumentsBulk 202 响应中返回的作业 ID ( |
返回
批量文档生成作业的状态和结果详细信息。
定义
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 日期和时间。 |
|
Zip Url
|
zipUrl | string |
生成的 ZIP 文件的临时下载 URL。 对于批量生成,此链接在生成时间起的 24 小时内有效。 |
|
错误消息
|
errorMessage | string |
作业级错误消息(如果业务流程失败)。 |
|
failedGenerations
|
failedGenerations | array of bulkGenerationFailureItemDto |
大容量生成作业中失败项的集合。 |
|
失败的生成计数
|
failedGenerationCount | integer |
批量生成作业中的失败项数。 |
categoryDto
模板类别信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | uuid |
唯一的 标识符。 |
|
name
|
name | string |
显示名称。 |
contentControlInfoDto
模板中发现的一个Word内容控件或占位符的元数据。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
title
|
title | string |
内容控件标题。 |
|
标签
|
tag | string |
用作 JSON 字段键的内容控件标记。 |
|
类型
|
type | string |
内容控件类型。 |
pagedResponseOffsetDto_templateInfoDto
基于偏移的分页响应,包含模板记录。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
数据
|
data | array of templateInfoDto |
包含模板占位符值的 JSON 对象。 |
|
页码
|
pageNumber | integer |
当前页码。 |
|
页面大小
|
pageSize | integer |
每页记录数。 |
|
记录总数
|
totalRecords | integer |
可用记录总数。 |
|
总页数
|
totalPages | integer |
总页数。 |
templateInfoDto
模板列表终结点返回的模板目录项。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
id | uuid |
唯一的 标识符。 |
|
Name
|
name | string |
显示名称。 |
|
Description
|
description | string |
人工可读说明。 |
|
创建日期
|
createdOn | date-time |
创建模板的 UTC 日期和时间。 |
|
上次修改时间
|
lastModified | date-time |
上次修改模板的 UTC 日期和时间。 |
|
categories
|
categories | array of categoryDto |
模板类别。 |
文件
这是基本数据类型“file”。
对象
这是类型“object”。