TemplioniX(預覽)
TemplioniX 是一個文件產生 API,可從可重複使用的 Word 範本建立 DOCX 和 PDF 檔案。 使用此連接器擷取範本元資料、產生單一文件、執行批量文件產生、檢查批量工作狀態、下載產生結果,以及查看訂閱或使用資訊。
驗證是透過傳遞的 API 金鑰進行。
產生的批量 ZIP 下載連結有效期為 24 小時。
此連接器適用於以下產品和區域:
| 服務 | Class | Regions |
|---|---|---|
| Copilot Studio | 進階 | 除以下部分外,所有Power Automate區域: - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域, 但下列區域除外: - Azure Government regions - Azure中國地區 - 美國國防部 (DoD) |
| Power Apps | 進階 | 除以下部分外,所有Power Apps區域 - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| Power Automate(自動化服務) | 進階 | 除以下部分外,所有Power Automate區域: - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 連絡人 | |
|---|---|
| 名稱 | TemplioniX 支援 |
| URL | https://templionix.com |
| support@templionix.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | TemplioniX |
| 網站 | https://templionix.com |
| 隱私策略 | https://templionix.com/privacy-policy |
| 使用規定 | https://templionix.com/terms-of-use |
| 類別 | 生產力;內容和文件 |
| 圖示品牌顏色 | #333A41 |
TemplioniX 連接器
Overview
TemplioniX 是一項文件產生服務,協助從可重複使用的 Microsoft Word 範本和結構化 JSON 資料中建立 DOCX 和 PDF 檔案。
此連接器允許使用者將Microsoft Power Automate、Power Apps、Azure Logic Apps 及 Copilot Studio 工作流程連接到 TemplioniX API。 使用者可以擷取範本元資料、產生起始 JSON 有效載荷、產生文件、執行大量文件產生工作、檢查工作狀態、下載產生的結果,以及擷取可用範本。
Publisher
TemplioniX
預計的 Microsoft 產品
- 微軟 Power Automate
此連接器實作為 Microsoft Power Platform 的客製化連接器,並可在支援認證連接器的其他 Microsoft 連接器體驗中使用。
驗證
連接器會使用 API 金鑰驗證。 API 金鑰會被傳送到請求標頭中 x-functions-key 。
使用者必須擁有有效的 TemplioniX 帳號及有效的 API 金鑰才能使用此連接器。
主要功能
取得範本
從 TemplioniX 檢索一份分頁式的文件範本清單。 此操作可用於在產生元資料、起始模型、單一文件或批量文件產生工作前選擇範本。
擷取範本欄位與佔位符
從選取的範本中擷取元資料,包括範本欄位與佔位符。 這有助於使用者了解範本所期望的資料。
產生一個模板的起始 JSON 有效載荷
根據所選範本產生範例 JSON payload。 使用者可將此有效載荷作為起點,將其他系統的資料映射到文件產生請求中。
產生文件
從選定範本產生 DOCX 或 PDF 文件並輸入 JSON 資料。
批量產生文件
啟動一個使用選取範本和多個輸入記錄的批量文件產生工作。 產生的批量 ZIP 下載連結有效期為 24 小時。
取得批量發電工作狀態
取得特定批量文件產生工作的狀態與結果資訊。
依範本取得大量生成工作
擷取與所選範本相關的批量產生工作。
常見使用情境
- 從結構化資料產生合約、發票、提案、報告、信函及其他商業文件。
- 自動化從 CRM、ERP、表單、Excel、SharePoint、Dataverse、SQL 或基於 API 的系統建立文件。
- 從工作流程中按需建立單一文件。
- 批量產生多份文件並取得產生的 ZIP 結果。
- 利用擷取的範本元資料來了解文件產生所需的欄位。
範例工作流程
- 手動或從業務事件觸發流程。
- 使用「取得範本」操作來選擇範本。
- 使用「產生起始 JSON payload 運算」來了解預期的資料結構。
- 將原始系統資料映射到產生的 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 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| TemplioniX API 金鑰 | 安全字串 | 此 API 的 TemplioniX API 金鑰 | True |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒鐘 |
動作
| 列出可用範本 |
回傳一個分頁的模板清單,可用於元資料擷取、模型產生及文件產生端點 |
| 列出批量產生的工作範本 |
回傳 TemplateId 匹配的 bulk-generation 分割區的所有工作;與單一工作狀態相同的有效載荷形狀,依開始時間排序 下降 |
| 取得批量發電工作狀態 |
依 ID 載入工作狀態:狀態、開始/結束時間、完成時的 ZIP SAS URL、失敗時的編排錯誤,以及解析的每個項目產生失敗。 |
| 從範本資料產生文件 |
將提供的 JSON 有效載荷與所選範本合併,並回傳產生的文件。 用於 |
| 擷取範本欄位與佔位符 |
讀取所選範本,並回傳文件中發現的內容控制項,包括標題、標籤、類型及預先定義的值(若有)。 |
| 產生一個模板的起始 JSON 有效載荷 |
建立一個範例 JSON 結構,與所選範本中發現的佔位符相符,以便可重複使用作為文件產生的輸入 |
| 開始批量文件產生 |
啟動批量工作,從共享範本產生文件,建立一個帶有讀取 SAS URL 的 ZIP,並追蹤進度。 立即回傳職缺ID。 回傳的 ZIP 下載網址會在工作完成後開放,且有效期為產生時間起的 24 小時。 |
列出可用範本
回傳一個分頁的模板清單,可用於元資料擷取、模型產生及文件產生端點
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
頁碼
|
pageNumber | True | integer |
以 1 為基礎的頁面索引回傳 |
|
頁面大小
|
pageSize | True | integer |
單一回應中最多可返回的範本數量 |
傳回
基於偏移量的分頁回應,包含範本記錄。
列出批量產生的工作範本
回傳 TemplateId 匹配的 bulk-generation 分割區的所有工作;與單一工作狀態相同的有效載荷形狀,依開始時間排序 下降
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
範本識別碼
|
templateId | True | uuid |
只有以此模板 ID 開始的工作才會回傳 |
傳回
- response
- array of bulkGenerationJobStatusDto
取得批量發電工作狀態
依 ID 載入工作狀態:狀態、開始/結束時間、完成時的 ZIP SAS URL、失敗時的編排錯誤,以及解析的每個項目產生失敗。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
批量工作識別碼
|
jobId | True | string |
工作編號在 generateDocumentsBulk 202 回覆中回傳 ( |
傳回
批量文件產生工作的狀態與結果詳情。
從範本資料產生文件
將提供的 JSON 有效載荷與所選範本合併,並回傳產生的文件。 用於 .docx Word 輸出或 .pdf PDF 輸出
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
範本
|
templateId | uuid |
唯一範本識別碼 |
|
|
資料
|
data | object |
JSON 物件,包含模板佔位符的值。 |
|
|
文件名稱
|
documentName | string |
產生文件名稱(不含擴充功能),除非你的 API 接受擴充功能 |
|
|
Format
|
format | string |
輸出格式。 Word文件用 .docx,PDF 文件用 .pdf。 |
傳回
- response
- file
擷取範本欄位與佔位符
讀取所選範本,並回傳文件中發現的內容控制項,包括標題、標籤、類型及預先定義的值(若有)。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
範本識別碼
|
templateId | True | uuid |
模板目錄回傳的唯一範本識別碼 |
傳回
- response
- array of contentControlInfoDto
產生一個模板的起始 JSON 有效載荷
建立一個範例 JSON 結構,與所選範本中發現的佔位符相符,以便可重複使用作為文件產生的輸入
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
範本識別碼
|
templateId | True | uuid |
模板目錄回傳的唯一範本識別碼 |
傳回
- response
- object
開始批量文件產生
啟動批量工作,從共享範本產生文件,建立一個帶有讀取 SAS URL 的 ZIP,並追蹤進度。 立即回傳職缺ID。 回傳的 ZIP 下載網址會在工作完成後開放,且有效期為產生時間起的 24 小時。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
範本
|
templateId | uuid |
唯一範本識別碼 |
|
|
Format
|
format | string |
輸出格式。 Word文件用 .docx,PDF 文件用 .pdf |
|
|
檔案名稱
|
fileName | string |
產生或請求的檔案名稱 |
|
|
items
|
items | object |
傳回
當批次文件產生工作被接受處理時,回應會回傳。
定義
bulkGenerationAcceptedDto
當批次文件產生工作被接受處理時,回應會回傳。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
作業識別碼
|
jobId | string |
唯一批量產生工作識別碼。 |
|
開始於
|
startedAt | date-time |
行動開始的時間與世界協調時間。 |
bulkGenerationFailureItemDTO
關於一次批量生成作業中失敗的文件項目資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
全球指數
|
globalIndex | string |
失敗產生項目的索引或內部識別碼。 |
|
檔案名稱
|
fileName | string |
產生或請求的檔名。 |
|
錯誤
|
error | string |
失敗商品的錯誤訊息。 |
bulkGenerationJobStatusDto
批量文件產生工作的狀態與結果詳情。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
作業識別碼
|
jobId | string |
唯一批量產生工作識別碼。 |
|
範本識別碼
|
templateId | uuid |
唯一的範本識別碼。 |
|
現況
|
status | string |
目前工作狀態,例如:待處理、執行中、已完成、失敗或部分完成。 |
|
開始於
|
startedAt | date-time |
行動開始的時間與世界協調時間。 |
|
結束時間
|
endTime | date-time |
工作結束的UTC日期和時間。 |
|
壓縮網址
|
zipUrl | string |
產生的 ZIP 檔案的臨時下載 URL。 對於批量生成,此連結有效期為產生時間起計 24 小時。 |
|
錯誤訊息
|
errorMessage | string |
如果編排失敗,則會出現工作層級錯誤訊息。 |
|
失敗的世代
|
failedGenerations | array of bulkGenerationFailureItemDto |
在批量生產作業中收集失敗物品。 |
|
失敗世代計數
|
failedGenerationCount | integer |
一次批量生產作業中失敗項目數量。 |
分類Dto
範本分類資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
id
|
id | uuid |
唯一的 識別碼。 |
|
name
|
name | string |
顯示名稱。 |
內容控制資訊
在範本中發現一個 Word 內容控制項或佔位符的元資料。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
title
|
title | string |
內容控制標題。 |
|
加標籤
|
tag | string |
內容控制標籤用作 JSON 欄位鍵。 |
|
型別
|
type | string |
內容控制類型。 |
pagedResponseOffsetDto_templateInfoDto
基於偏移量的分頁回應,包含範本記錄。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
資料
|
data | array of templateInfoDto |
JSON 物件,包含模板佔位符的值。 |
|
頁碼
|
pageNumber | integer |
目前頁碼。 |
|
頁面大小
|
pageSize | integer |
每頁的記錄數。 |
|
記錄總數
|
totalRecords | integer |
可用紀錄總數。 |
|
總頁數
|
totalPages | integer |
總頁數。 |
模板InfoDto
範本目錄項目由範本清單端點回傳。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | uuid |
唯一的 識別碼。 |
|
名稱
|
name | string |
顯示名稱。 |
|
Description
|
description | string |
人類易讀的描述。 |
|
創建日期
|
createdOn | date-time |
模板建立的UTC日期和時間。 |
|
上次修改
|
lastModified | date-time |
模板最後修改的UTC日期和時間。 |
|
類別
|
categories | array of categoryDto |
範本分類。 |
檔案
這是基本資料類型「檔案」。
物件
這是類型 'object'。