APITemplate（獨立出版商）

透過 APITemplate.io 服務，您可以建立 PDF 文件和影像，並管理範本。從可重複使用的模板生成社交媒體圖像、橫幅或 PDF，無需編碼！

此連接器適用於以下產品和區域：

服務	Class	Regions
副駕駛工作室	進階	除下列區域外的所有 Power Automate 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）
邏輯應用程式	標準	所有 Logic Apps 區域，但下列區域除外： - Azure Government 區域 - Azure 中國區域 - 美國國防部（DoD）
Power Apps	進階	除下列區域外的所有 Power Apps 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）
Power Automate（自動化服務）	進階	除下列區域外的所有 Power Automate 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）

連絡人
名稱	特洛伊·泰勒
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

連接器中繼資料
Publisher	特洛伊·泰勒
網站	https://apitemplate.io/
隱私策略	https://apitemplate.io/privacy-policy/
類別	內容和文件

正在建立連線

連接器支援下列驗證類型：


預設值	建立連線的參數。	所有區域	不可共享

預設

適用：所有地區

建立連線的參數。

這不是可共用的連線。如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。

名稱	類型	Description	為必填項目
API 金鑰	securestring	此 API 的 API 金鑰	對

節流限制

名稱	呼叫	續約期間
每個連線的 API 呼叫	100	60 秒

動作

列出產生的物件	擷取所有產生的 PDF 和影像的清單。
刪除物件	從 CDN 刪除 PDF 或圖像並將交易標記為已刪除。
合併多個 PDF	此動作會將多個 PDF 合併/聯結為單一 PDF 檔案。
建立 PDF	此請求會建立包含 JSON 資料和範本的 PDF 檔案。支持同步和非同步 PDF 生成。
建立映像	此請求會從 JSON 資料和範本建立 JPEG 檔案（以及 PNG）。
更新 PDF 範本	此動作會更新 PDF 範本。
清單範本	擷取範本及其資訊的清單。
獲取 PDF 模板	擷取有關 PDF 範本的資訊。

列出產生的物件

作業識別碼：: ObjectsGet

擷取所有產生的 PDF 和影像的清單。

參數

名稱	機碼	類型	Description
限制	limit	string	只擷取指定的記錄數目。預設為 300
Offset	offset	string	偏移用於跳過結果中的記錄數。預設為 0
範本識別碼	template_id	string	依範本識別碼篩選
交易類型	transaction_type	string	依交易類型篩選，選項為 `PDF`或 `JPEGMERGE`

傳回

回應成功清單物件: ResponseSuccessListObjects

刪除物件

作業識別碼：: ObjectDelete

從 CDN 刪除 PDF 或圖像並將交易標記為已刪除。

參數

名稱	機碼	必要	類型	Description
交易參考	transaction_ref	True	string	物件交易參考

傳回

回應成功刪除物件: ResponseSuccessDeleteObject

合併多個 PDF

作業識別碼：: PDFMerge

此動作會將多個 PDF 合併/聯結為單一 PDF 檔案。

參數

名稱	機碼	必要	類型	Description
Meta	meta		string	指定外部參考 ID 供您自己的參考。它會出現在 API 中 `list-objects` 。
URL	urls	True	array of string	URL 陣列。我們支援普通的 http/https URL 和資料 URL。一般網址：網址以 http/https 開頭，例如：「https://fileserver.com/a1.pdf")。資料 URL：以「data：」配置為前置詞的 URL，例如「data：application/pdf;base64，JVBERi0xLjIg.。[截斷]”
匯出類型	export_type		string	或 `filejson`（預設值）。此選項 `json` 會傳回JSON物件，而輸出的PDF會儲存在CDN上。此選項 `file` 會傳回所產生 PDF 的二進位資料（安全且完全私密），且回應 HTTP 標頭 Content-Disposition 會設定為 attachment。它的檔案大小限制為 6MB。
Expiration	expiration		integer	產生的PDF在幾分鐘內到期（預設為 `0`，永久儲存）。用於 `0` 永久存儲在 cdn 上。或使用分鐘到`43200`分鐘（30 天）之間的`1`範圍來指定生成的 PDF 的到期時間
雲端存放裝置	cloud_storage		integer	將產生的 PDF/圖片上傳到我們的儲存 CDN，預設為 `1`。如果您已設定 `Post Action` 將 PDF/影像上傳至您自己的 S3，請將其設定為 `0`。

傳回

回應成功單一檔案: ResponseSuccessSingleFile

建立 PDF

作業識別碼：: PDFPost

此請求會建立包含 JSON 資料和範本的 PDF 檔案。支持同步和非同步 PDF 生成。

參數

名稱	機碼	必要	類型	Description
範本識別碼	template_id	True	string	您的範本ID，可在Web主控台（管理範本）中取得
匯出類型	export_type		string	或 `filejson`（預設值）。此選項 `json` 會傳回JSON物件，而輸出的PDF會儲存在CDN上。將此專案與參數 `expiration`. 此選項 `file` 會傳回所產生 PDF 的二進位資料（安全且完全私密），且回應 HTTP 標頭 Content-Disposition 會設定為 attachment。
Expiration	expiration		integer	產生的PDF在幾分鐘內到期（預設為 `0`，永久儲存）。用於 `0` 永久存儲在 cdn 上。或使用分鐘到`10080`分鐘（7天）之間的`1`範圍來指定生成的PDF的到期時間
輸出HTML	output_html		string	或 `10`（預設值）。若要啟用html內容的輸出，請將值設定為 `1` ，它會在JSON回應中傳回為html_url欄位（作為URL）
輸出格式	output_format		string	（ `pdf`預設）或 `html`.. 默認情況下，它正在生成 PDF。但是，您可以指定 output_format=html 以僅產生 HTML（它會在 JSON 回應中傳回為 download_url 欄位作為 URL）。
檔名	filename		string	預設為UUID（例如 0c93bd9e-9ebb-4634-a70f-de9131848416.pdf）。使用此選項來指定自訂檔案名稱，它應該以 `.pdf`
大型重採樣分辨率	image_resample_res		string	默認情況下，我們嵌入原始圖像，這意味著 PDF 文件大小較大。指定選項 'image_resample_res' 有助於將目前 PDF 的影像縮減取樣至解析度（以 DPI 為單位），以減少 PDF 檔案大小。常見值為 72、96、150、300 和 600。
是 CMYK	is_cmyk		string	使用 CMYK 色彩設定檔，1=true，0=false。預設為「0」
雲端存放裝置	cloud_storage		integer	將產生的 PDF/圖片上傳到我們的儲存 CDN，預設為 `1`。如果您已設定 `Post Action` 將 PDF/影像上傳至您自己的 S3，請將其設定為 `0`。
Meta	meta		string	指定外部參考 ID 供您自己的參考。它會出現在 API 中 `list-objects` 。
非同步	async		string	或 `10`（預設值）。 `0` is synchronous call（預設）， `1` 是非同步呼叫。若要非同步產生PDF，請將值設定為， `1` API呼叫會立即傳回。生成 PDF 文檔後，我們將對您的 URL（webhook_url）進行 HTTP/HTTPS GET 並重試 3 次後放棄。如果設定為 `1`，則`asyncwebhook_url`為必要
Webhook 網址	webhook_url		string	它是您的 Webhook URL 的 URL，它以 http:// 或 https:// 開頭，並且必須進行 urlencoded。如果設定為，則`async`您必須指定 `webhook_url`。`1` Webhook 回呼的格式一旦 PDF 產生，我們將對以下 URL 發起 HTTP/HTTPS GET 呼叫：https：//`[yourwebserver.com]`？&primary_url=`[primary_url]`&transaction_ref=`[transaction_ref]`&status=`[status]`&message=`[message]`。 `[yourwebserver.com]`：要處理回呼的 Web 服務，即 `webhook_url`. `[primary_url]`：PDF 文件的 URL。 `[transaction_ref]`：交易參考號碼。 `[status]` ：交易的狀態， `success` 或 `error`。 `[message]` ：狀態訊息以下是回呼伺服器https://yourwebserver.com?&的範例 Webhook;primary_url=https%3A%2F%2Fpub-cdn.apitemplate.io%2F2021%2F06%2Fb692183d-46d7-3213-891a-460a5814ad3f.pdf&transaction_ref=b692183d-46d7-3213-891a-460a5814ad3f&status=success
			object

傳回

回應成功PDFFile: ResponseSuccessPDFFile

建立映像

作業識別碼：: ImagePost

此請求會從 JSON 資料和範本建立 JPEG 檔案（以及 PNG）。

參數

名稱	機碼	必要	類型	Description
範本識別碼	template_id	True	string	您的範本ID，可在Web主控台中取得
Expiration	expiration		integer	生成的圖像在幾分鐘內到期（默認為 `0`永久存儲）。用於 `0` 永久存儲在 cdn 上。或使用分鐘到`10080`分鐘（7天）之間的`1`範圍來指定生成圖像的到期時間
雲端存放裝置	cloud_storage		integer	將產生的 PDF/圖像上傳到我們的儲存 CDN 並產生一個 URL，預設為 `1`。如果您已將 in `Post ActionsAPI Integration` 設定為將產生的 PDF/影像上傳至您自己的私人 S3，請將 cloud_storage 設定為 `0`。如果，請 `export_type=file`忽略這一點。
輸出影像類型	output_image_type		string	輸出影像類型（JPEG 或 PNG 格式），預設為 `all`。選項為 `all`、、`jpegOnlypngOnly`。
Meta	meta		string	指定外部參考 ID 供您自己的參考。它會出現在 API 中 `list-objects` 。
			object

傳回

回應成功影像檔案: ResponseSuccessImageFile

更新 PDF 範本

作業識別碼：: TemplateUpdate

此動作會更新 PDF 範本。

參數

名稱	機碼	必要	類型	Description
範本識別碼	template_id	True	string	您的範本ID，可在Web主控台中取得（管理範本）
身體	body		string	HTML 內文
CSS	css		string	CSS 的

傳回

回應成功: ResponseSuccess

清單範本

作業識別碼：: TemplatesGet

擷取範本及其資訊的清單。

參數

名稱	機碼	類型	Description
限制	limit	string	只擷取指定的記錄數目。預設為 300
Offset	offset	string	偏移用於跳過結果中的記錄數。預設為 0
格式	format	string	若要依「PDF」或「JPEG」篩選範本
範本識別碼	template_id	string	依範本識別碼篩選範本
群組名稱	group_name	string	依群組名稱篩選範本
使用圖層信息	with_layer_info	string	與影像範本的圖層資訊一起傳回，0=false，1=true。預設為「0」

傳回

回應成功清單範本: ResponseSuccessListTemplates

獲取 PDF 模板

作業識別碼：: TemplateGet

擷取有關 PDF 範本的資訊。

參數

名稱	機碼	必要	類型	Description
範本識別碼	template_id		string	您的範本ID，可在Web主控台（管理範本）中取得

傳回

回應成功範本: ResponseSuccessTemplate

定義

回應成功

名稱	路徑	類型	Description
地位	status	string	地位

回應成功範本

名稱	路徑	類型	Description
地位	status	string	地位
範本識別碼	template_id	string	範本識別碼
身體	body	string	範本的 HTML 內文
CSS	css	string	模板的 CSS
設定	settings	string	範本的列印設定

回應成功PDFFile

名稱	路徑	類型	Description
地位	status	string	地位
下載網址	download_url	string	下載網址
範本識別碼	template_id	string	範本識別碼
交易參考	transaction_ref	string	交易參考
發布動作	post_actions	array of object	帖子動作。
items	post_actions	object

回應成功影像檔案

名稱	路徑	類型	Description
地位	status	string	地位
下載網址	download_url	string	下載網址
下載網址 PNG	download_url_png	string	下載網址 PNG
範本識別碼	template_id	string	範本識別碼
交易參考	transaction_ref	string	交易參考
發布動作	post_actions	array of object	帖子動作。
items	post_actions	object

回應成功清單範本

名稱	路徑	類型	Description
地位	status	string	狀態。
範本	templates	array of object	範本
items	templates	object

回應成功清單物件

名稱	路徑	類型	Description
地位	status	string	狀態。
物件	objects	array of object	對象。
items	objects	object

回應成功刪除物件

名稱	路徑	類型	Description
地位	status	string	狀態。

回應成功單一檔案

名稱	路徑	類型	Description
地位	status	string	地位
主要 URL	primary_url	string	產生的 PDF 文件
交易參考	transaction_ref	string	交易參考

共用方式為