交易報告計費 API transaction-reports-billable-apis

版本
文章連結
AEM 6.5
按一下這裡
AEM as a Cloud Service
本文章

AEM Forms提供多個API來提交表單、處理檔案和轉譯檔案。 有些API是以交易入帳,其他則可供自由使用。 本檔案提供在交易報表中作為交易入帳的所有API清單。 以下是一些使用計費API的常見案例:

  • 提交最適化表單
  • 將檔案從一種格式轉換為另一種格式
  • 平面化動態PDF檔案
  • 產生記錄檔案(使用Forms服務或輸出服務)
  • 將互動式PDF檔案與另一個PDF檔案合併
  • 使用AEM Workflow的指派工作步驟和通訊API步驟

帳單API不考慮頁數、檔案或表單的長度,或轉譯檔案的最終格式。 交易報表將交易分為兩個類別:「Forms已提交」和「檔案已呈現」。

  • Forms已提交: ​從使用AEM Forms建立的任何型別的表單提交資料,且資料已提交至任何資料儲存庫或資料庫時,即視為表單提交。 例如,提交最適化表單或表單集會視為已提交的表單。 如果表單集有5個表單,在提交表單集時,交易報告服務將其計為5個提交。

  • 已轉譯的檔案: ​透過結合範本和資料來產生檔案、以數位方式簽署或認證檔案、使用檔案服務的計費檔案服務API,或將檔案從一種格式轉換為另一種格式,均被視為已轉譯的檔案。

可記帳檔案服務API billable-document-services-apis

產生PDF服務 generate-pdf-service

API
說明
交易報告類別
其他資訊
createPDF
從範本產生PDF檔案,並將資料合併到其中。
已處理的文件
exportPDF
將XDP檔案或PDF檔案轉換為支援的檔案型別。
已處理的文件

輸出服務 output-service

API
說明
交易報告類別
其他資訊
generatePDFOutput
合併資料和範本以建立PDF檔案。
已處理的文件
generatePDFOutput (PDFOutputOptions)
合併資料和範本以建立PDF檔案。
已處理的文件
generatePDFOutputBatch
合併資料和範本以建立一組PDF檔案。
已處理的文件
generatePrintedOutput
將XDP和PDF檔案轉換為PostScript (PS)、印表機命令語言(PCL)和ZPL檔案格式。
已處理的文件
generatePrintedOutput (PrintedOutputOptions)
將XDP和PDF檔案轉換為PostScript (PS)、印表機命令語言(PCL)和ZPL檔案格式。
已處理的文件
generatePrintedOutputBatch
將一組XDP和PDF檔案轉換為一組PostScript (PS)、印表機命令語言(PCL)和ZPL檔案格式。
已處理的文件

DocAssurance服務 DocAssurance-Service

API
說明
交易報告類別
其他資訊
secureDocument
此API可讓您保護檔案的安全。 您可以使用API來簽署、認證、讀取器延伸或加密PDF檔案。
已處理的文件
只對secureDocument的簽署和認證操作收費。

記錄檔案(DOR)服務 document-of-record-dor-forms-service-and-output-service

API
說明
交易報告類別
其他資訊
轉譯
叫用指定的轉譯方法,以使用提供的引數產生記錄檔案。
使用Forms服務處理的檔案

組合器服務 assembler-service

API
說明
交易報告類別
其他資訊
叫用
在指定的輸入檔案上執行DDX,並傳回包含結果檔案的物件
已處理的文件

下列作業不會作為交易入帳:

  • 建立套件或投資組合
  • 拼接多個XDP
叫用
在指定的輸入檔案上執行DDX,並傳回包含結果檔案的物件
已處理的文件
PDF Generator、Forms和輸出服務支援的所有輸入檔案格式,組合器服務都支援所有這些格式作為輸出檔案格式。
toPDFA
使用指定的選項將指定的檔案轉換為PDF/A。
已處理的文件

當您執行下列一或多個作業時,叫用API的使用量會計為交易:

  1. 從非PDF格式轉換成PDF格式。
  2. 從PDF格式轉換為PDF/A格式。
  3. 從PDF格式轉換為非PDF格式。 範例包括從PDF到影像格式的轉換或從PDF到文字格式的轉換。
NOTE
  • 組合器服務的叫用API可以在內部根據輸入呼叫另一個服務的計費的API。 因此,叫用API可計為無、單一或多個交易。 計算交易數取決於輸入和叫用的內部API。
  • 使用組合器服務產生的單一PDF檔案可計為無、單一或多個交易。 計算的交易數取決於提供的代碼。

可記帳資料擷取API billable-data-capture-apis

所有最適化表單的提交事件都會入帳為交易。 依預設,PDF表單的提交不會作為交易入帳。 使用提供的交易錄製器API,將PDF forms提交記錄為交易。

最適化表單 adaptive-forms

使用案例
說明
交易報告類別
其他資訊
提交最適化表單
提交最適化表單以設定提交動作。
已提交的表單
  • 單一或兩個交易的成功提交帳戶。 計算交易數取決於用於提交的提交動作型別。 例如,透過電子郵件傳送PDF時,提交動作會計算兩個交易計數。 一個交易用於表單提交,另一個交易用於使用記錄檔案(DOR)服務產生的PDF。
  • 在最適化表單(最適化表單集)中使用最適化表單時,只會計算單一交易。 在最適化表單中可以有任意數量的最適化表單。

計費表單中心的AEM工作流程 billable--form-centric-aem-workflows

以「表單為中心的AEM工作流程」的指定作業與檔案服務步驟會作為異動入帳。 如果工作流程步驟將交易入帳,但工作流程無法完成,則不會迴轉交易計數。

以表單為中心的AEM工作流程 form-centric-aem-workflows

使用案例
交易報告類別
其他資訊
提交指派工作步驟
已提交的表單
提交工作流程應用程式起點
已提交的表單

將可記帳API記錄為自訂程式碼的交易 recording-billable-apis-as-transactions-for-custom-code

提交PDF表單、使用代理程式UI預覽互動式通訊、使用非標準表單提交和自訂實施等動作不會計為交易。 AEM Forms提供API來記錄此類動作,例如交易。 您可以從自訂實作呼叫API以記錄交易

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab