Ironfang 渲染圖(預覽)

Ironfang Render 將網頁和 HTML 轉換成截圖和 PDF 文件。 可以擷取頁面為 PNG、JPEG 或 WebP,將 URL 或自己的 HTML 列印成 PDF,或排隊渲染工作,檔案準備好後再收集。 沒有瀏覽器需要執行或維護。

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

Service Class Regions
Copilot Studio 進階 除下列區域外的所有 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)
連絡人
Name 鐵牙
URL https://ironfang.com/contact
Email hello@ironfang.com
連接器中繼資料
Publisher 鐵牙
Website https://ironfang.com/render
隱私權原則 https://ironfang.com/legal/privacy
Categories 內容和文件;生產力

鐵牙 渲染

Ironfang Render 將網頁和 HTML 轉換成截圖和 PDF 文件。 透過此連接器,流程可以擷取頁面為影像、列印 URL 或自身 HTML 轉成 PDF,或排隊渲染工作並在檔案準備好時收集,無需瀏覽器。

Publisher:Ironfang

Prerequisites

你需要一個 Ironfang 帳號和 API 金鑰。 帳號可免費在 https://portal.ironfang.com,且每個帳號每月都包含免費的渲染獎勵。 超出津貼的使用費用會計入你的 Ironfang 帳戶;目前利率為 https://ironfang.com/pricing。

支援的作業

擷取螢幕快照

渲染網頁或 HTML 區塊,並回傳圖片為 PNG、JPEG 或 WebP。 選擇視窗大小、擷取整個可滾動頁面或單一元素、模擬手機或平板、使用深色調,並隱藏餅乾橫幅或阻擋廣告。

建立 PDF

將網頁或 HTML 塊列印成最多 100 頁的 PDF 文件,並回傳檔案。 選擇紙張尺寸、方向、邊距、背景,以及頁首和頁尾範本。

開始截圖工作

會將截圖排隊列為持久工作,並立即回傳其 ID。 當流程不應該等待渲染,或是讓檔案在後續步驟中保持可用時,請使用它。

開始一份PDF工作

將 PDF 排隊為持久工作,並立即回傳其 ID。

去做渲染工作

回傳一個工作狀態:排隊中、執行中、成功、失敗或取消。 成功的工作會包含其檔案的大小與類型,以及一個已簽署的下載連結;失敗的工作包含原因。

下載工作結果

回傳成功產生的檔案。

取得憑證

連接器使用 Ironfang API 金鑰進行認證。

  1. 請登入 https://portal.ironfang.com,或在那裡建立免費帳號。
  2. 打開 API 金鑰並建立一個金鑰。 只有 render:render 範圍的金鑰就足夠完成這個連接器裡的所有動作。
  3. 複製以if_live_開頭的鑰匙。 它只出現過一次。
  4. 建立連線時,將金鑰貼到 API 金鑰欄位。

使用者入門

要將你自己的 HTML PDF 儲存到 SharePoint:

  1. 新增「建立 PDF 」的動作,並將你的 HTML 放入 HTML 欄位。 把紙張尺寸設為 a4。
  2. 新增 SharePoint 的「建立檔案」動作。 使用以 .pdf結尾的檔案名稱,並以 Create a PDF 的 PDF 內容輸出作為檔案內容。

要在排程中擷取頁面:

  1. 先從復發觸發器開始。
  2. 新增截圖並附上頁面網址,若想完整頁面,則開啟全頁。
  3. 新增OneDrive建立檔案的動作,檔案名稱以 .png 結尾,並將影像內容輸出作為檔案內容。

如果是長批次,可以用「Start a screenshot job」或「Start a PDF job」,然後做 Do until 循環,延遲至少 5 秒,再用 Get a render 工作直到狀態為成功、失敗或取消,最後以「Download a job result」收尾。

完整的 API 文件請見 https://ironfang.com/render/docs。

已知問題和限制

  • 請求時可以寄出頁面網址或 HTML,不要兩者同時提供。
  • 每次渲染時間限制為30秒。 需要較長時間才能準備好的頁面會因渲染錯誤而失敗。
  • PDF 最多可有 100 頁,圖片寬度或高度最多可達 4096 像素。 一整頁的擷取高度最多為 20000 像素。
  • 工作成功後,該檔案會保留 24 小時,而「取得渲染工作」中的簽署下載連結可維持 15 分鐘。 下載工作結果後,24小時內可再次被撥打。
  • 一個帳號可以同時執行兩個渲染。 超過此範圍的請求將以狀態429被拒,應在短暫等待後重新嘗試;工作則會等待在佇列中。
  • 相同請求在 10 分鐘內可能會回傳先前的渲染。 開啟跳過快取以強制建立新的快取。
  • 登入後方的頁面尚未能透過此連接器擷取。

常見問題

我的檔案裡有新增什麼嗎?

No. 透過 API 呈現的檔案不會帶有 Ironfang 徽章或浮水印。

我該去哪裡尋求幫助?

聯絡 Ironfang,電話為 https://ironfang.com/contacthello@ironfang.com或 。 服務狀態為 https://status.ironfang.com。

部署指示

使用 Power Platform CLI 將此連接器部署為自訂連接器:

pac connector create --api-definition-file apiDefinition.swagger.json --api-properties-file apiProperties.json --icon-file icon.png

然後用你的 Ironfang API 金鑰建立連線。

正在建立連線

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

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

預設

適用:所有地區

建立連線的參數。

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

Name 類型 Description Required
API 金鑰 安全字串 你的 Ironfang API 金鑰,開頭是 if_live_。 True

動作

下載工作結果

回傳成功產生的檔案。 工作成功後,結果會保存24小時。

去做渲染工作

回傳一份狀態的渲染工作。 成功的工作會包含結果的細節,失敗的工作則會記錄錯誤。

建立 PDF

將網頁或 HTML 區塊列印成最多 100 頁的 PDF 文件,並回傳檔案。 寄一個頁面網址或 HTML,不要兩者都寄。

擷取螢幕快照

在瀏覽器中渲染網頁或 HTML 區塊並回傳圖片。 寄一個頁面網址或 HTML,不要兩者都寄。

開始一份PDF工作

將 PDF 排隊為持久工作,然後立即返回。 用「Get a render job」檢查工作,然後用「Download a job result」來檢查。 完成的檔案會保存24小時。

開始截圖工作

排隊截圖為持久作業,然後立刻回來。 用「Get a render job」檢查工作,然後用「Download a job result」來檢查。 完成的檔案會保存24小時。

下載工作結果

回傳成功產生的檔案。 工作成功後,結果會保存24小時。

參數

名稱 機碼 必要 類型 Description
作業識別碼
id True string

渲染工作開始時回傳的 ID。

傳回

工作產生的檔案。

檔案內容
binary

去做渲染工作

回傳一份狀態的渲染工作。 成功的工作會包含結果的細節,失敗的工作則會記錄錯誤。

參數

名稱 機碼 必要 類型 Description
作業識別碼
id True string

渲染工作開始時回傳的 ID。

傳回

機身
Job

建立 PDF

將網頁或 HTML 區塊列印成最多 100 頁的 PDF 文件,並回傳檔案。 寄一個頁面網址或 HTML,不要兩者都寄。

參數

名稱 機碼 必要 類型 Description
頁面網址
url string

列印頁面的地址。 傳送 HTML 時請留空。

HTML
html string

列印用的 HTML 標記。 傳送頁面網址時請留空。

紙張尺寸
paper_format string

標示的紙張尺寸。 當它為空時,則使用字母。

景觀
landscape boolean

是否要橫向列印。

印刷背景
print_background boolean

是否包含背景色和圖片,就像瀏覽器列印對話框可以做到的那樣。

頂邊距(英吋)
top float

頂端邊距以英吋為單位。

右邊距(英吋)
right float

右邊距(英吋)。

底部邊距(英吋)
bottom float

底部邊距以英吋為單位。

左邊距(英吋)
left float

左邊邊緣以英吋為單位。

標頭HTML
header_html string

HTML 範本印在每頁頂端。

頁尾 HTML
footer_html string

HTML 範本印在每頁底部。

Scale
scale float

印刷比例,1 是實際尺寸。

等到
wait_until string

當那頁算作準備好時。 網路閒置會等待網路流量停止。

隱藏 Cookie 橫幅
block_cookie_banners boolean

是否要隱藏常見的 cookie 同意橫幅。 它們被隱藏起來,從未被接受。

封鎖廣告
block_ads boolean

是否要封鎖已知廣告和追蹤網路的請求。

傳回

PDF檔案內容。

PDF 內容
binary

擷取螢幕快照

在瀏覽器中渲染網頁或 HTML 區塊並回傳圖片。 寄一個頁面網址或 HTML,不要兩者都寄。

參數

名稱 機碼 必要 類型 Description
頁面網址
url string

要擷取的頁面地址。 傳送 HTML 時請留空。

HTML
html string

要渲染的 HTML 標記。 傳送頁面網址時請留空。

圖像格式
format string

圖片檔案格式。 PNG 是無損的,而 WebP 通常是最小的檔案。

整頁
full_page boolean

是否要擷取整個可捲動頁面,而非僅僅可見區域。

寬度
width integer

瀏覽器視窗寬度(像素單位)最高可達 4096。

高度
height integer

瀏覽器視窗高度(像素)最高可達 4096。 它被忽略,取而代之的是整頁的捕捉。

裝置
device string

擷取頁面時,就像手機或平板會顯示的畫面,螢幕大小和使用者代理也會相符。

深色模式
dark_mode boolean

是否要渲染該頁面的深色調。

Quality
quality integer

JPEG 和 WebP 的畫質從 1 到 100。 巴布亞紐幾內亞則被忽略。

元素選擇器
selector string

CSS 選擇器擷取一個元素,而不是整個視窗。

延遲(毫秒)
delay_ms integer

頁面載入後要等多久才能擷取,最多可達 10000 毫秒。

等到
wait_until string

當那頁算作準備好時。 網路閒置會等待網路流量停止。

隱藏 Cookie 橫幅
block_cookie_banners boolean

是否要隱藏常見的 cookie 同意橫幅。 它們被隱藏起來,從未被接受。

封鎖廣告
block_ads boolean

是否要封鎖已知廣告和追蹤網路的請求。

跳過快取
no_cache boolean

是否要強制重新渲染,而不是重複使用過去 10 分鐘的相同渲染。

傳回

截圖檔案內容。

圖片內容
binary

開始一份PDF工作

將 PDF 排隊為持久工作,然後立即返回。 用「Get a render job」檢查工作,然後用「Download a job result」來檢查。 完成的檔案會保存24小時。

參數

名稱 機碼 必要 類型 Description
冪性鍵
Idempotency-Key string

此請求的唯一值,例如流程執行 ID。 再傳送一次同樣的金鑰也不會產生第二個渲染。

頁面網址
url string

列印頁面的地址。 傳送 HTML 時請留空。

HTML
html string

列印用的 HTML 標記。 傳送頁面網址時請留空。

紙張尺寸
paper_format string

標示的紙張尺寸。 當它為空時,則使用字母。

景觀
landscape boolean

是否要橫向列印。

印刷背景
print_background boolean

是否包含背景色和圖片,就像瀏覽器列印對話框可以做到的那樣。

頂邊距(英吋)
top float

頂端邊距以英吋為單位。

右邊距(英吋)
right float

右邊距(英吋)。

底部邊距(英吋)
bottom float

底部邊距以英吋為單位。

左邊距(英吋)
left float

左邊邊緣以英吋為單位。

標頭HTML
header_html string

HTML 範本印在每頁頂端。

頁尾 HTML
footer_html string

HTML 範本印在每頁底部。

Scale
scale float

印刷比例,1 是實際尺寸。

等到
wait_until string

當那頁算作準備好時。 網路閒置會等待網路流量停止。

隱藏 Cookie 橫幅
block_cookie_banners boolean

是否要隱藏常見的 cookie 同意橫幅。 它們被隱藏起來,從未被接受。

封鎖廣告
block_ads boolean

是否要封鎖已知廣告和追蹤網路的請求。

您的參考
external_id string

你自己寫一份推薦信,最多120個字元。

傳回

機身
Job

開始截圖工作

排隊截圖為持久作業,然後立刻回來。 用「Get a render job」檢查工作,然後用「Download a job result」來檢查。 完成的檔案會保存24小時。

參數

名稱 機碼 必要 類型 Description
冪性鍵
Idempotency-Key string

此請求的唯一值,例如流程執行 ID。 再傳送一次同樣的金鑰也不會產生第二個渲染。

頁面網址
url string

要擷取的頁面地址。 傳送 HTML 時請留空。

HTML
html string

要渲染的 HTML 標記。 傳送頁面網址時請留空。

圖像格式
format string

圖片檔案格式。 PNG 是無損的,而 WebP 通常是最小的檔案。

整頁
full_page boolean

是否要擷取整個可捲動頁面,而非僅僅可見區域。

寬度
width integer

瀏覽器視窗寬度(像素單位)最高可達 4096。

高度
height integer

瀏覽器視窗高度(像素)最高可達 4096。 它被忽略,取而代之的是整頁的捕捉。

裝置
device string

擷取頁面時,就像手機或平板會顯示的畫面,螢幕大小和使用者代理也會相符。

深色模式
dark_mode boolean

是否要渲染該頁面的深色調。

Quality
quality integer

JPEG 和 WebP 的畫質從 1 到 100。 巴布亞紐幾內亞則被忽略。

元素選擇器
selector string

CSS 選擇器擷取一個元素,而不是整個視窗。

延遲(毫秒)
delay_ms integer

頁面載入後要等多久才能擷取,最多可達 10000 毫秒。

等到
wait_until string

當那頁算作準備好時。 網路閒置會等待網路流量停止。

隱藏 Cookie 橫幅
block_cookie_banners boolean

是否要隱藏常見的 cookie 同意橫幅。 它們被隱藏起來,從未被接受。

封鎖廣告
block_ads boolean

是否要封鎖已知廣告和追蹤網路的請求。

跳過快取
no_cache boolean

是否要強制重新渲染,而不是重複使用過去 10 分鐘的相同渲染。

您的參考
external_id string

你自己寫一份推薦信,最多120個字元。

傳回

機身
Job

定義

Job

名稱 路徑 類型 Description
作業識別碼
id string

作業的識別碼。

種類
kind string

渲染方式,比如截圖或 PDF。

Status
status string

工作狀態。 當工作成功、失敗或取消時即表示完成。

您的參考
external_id string

工作開始時給的推薦信。

嘗試次數
attempts integer

這個工作執行了多少次?

建立時間
created_at date-time

當工作被接受時。

從
started_at date-time

就是這份工作最後一次開始運作的時候。

完工地點
completed_at date-time

工作結束後。

錯誤代碼
error.code string

一個穩定的失敗代碼。

錯誤訊息
error.message string

這是對失敗的易讀描述。

內容類型
result.content_type string

結果檔案的媒體類型。

大小 (位元組)
result.bytes integer

結果檔案的大小(以位元組為單位)。

SHA256 雜湊
result.sha256 string

結果檔案的 SHA-256 雜湊值。

Available
result.available boolean

結果檔案是否仍能被下載。

結果於
result.expires_at date-time

當託管的結果檔案被刪除時,

下載鏈接
result.url string

一個不需要 API 金鑰的簽名連結,指向結果檔案。

下載連結於
result.url_expires_at date-time

當簽名下載連結停止使用時,

二進位

這是基本數據類型 『binary』。