AEM Forms通訊API — 概觀

AEM Forms API提供完整的雲端原生API套件,旨在協助企業自動化檔案工作流程。

AEM Forms API的結構化可透過兩個主要主控台進行存取:

  • Adobe Developer Console (ADC) - Adobe Developer Console是Adobe API、事件、執行階段和App Builder的閘道。

  • AEM Developer Console - AEM Developer Console可提供環境層級詳細資訊、設定、技術帳戶和服務認證的存取權,以支援作業和整合工作。

不同的API支援不同的驗證方法

驗證方法

不同的Forms API會根據其發行時間表使用不同的驗證方法:

舊版API支援JWT式伺服器對伺服器驗證,此驗證是透過AEM Developer Console進行設定和管理的。 較新的API使用OAuth伺服器對伺服器驗證,並透過Adobe Developer Console設定。

API分類概觀

所有AEM Forms API主要分為兩個部分:

詳細資訊
最適化表單傳送和執行階段API
通訊API
用途
處理最適化表單傳遞和執行階段作業
檔案產生與操作
使用案例
— 表單轉譯
— 資料預填
— 表單提交
— 草稿管理
- PDF產生
— 檔案合併
— 批次處理
— 列印作業
授權方法
支援OAuth伺服器對伺服器/使用者驗證方法。
根據API,支援伺服器對伺服器驗證(JWT或OAuth)。 API無法同時支援兩種驗證方法。

AEM Forms通訊API

通訊API是以檔案為中心的作業的主要焦點。

下表列出所有AEM Forms Communications API及其支援的驗證方法與執行模型:

Document Generation API

API端點
說明
執行模型
驗證方法
/adobe/forms/batch/output/config
為檔案產生作業建立新的批次組態。
非同步/批次
JWT
/adobe/forms/batch/output/config/{configName}
擷取特定批次設定的詳細資料。
非同步/批次
JWT
/adobe/forms/batch/output/config/configs
傳回所有可用批次設定的清單。
非同步/批次
JWT
/adobe/forms/batch/output/config/{configName}/execution
使用設定開始批次輸出產生執行。
非同步/批次
JWT
/adobe/forms/batch/output/config/{configName}/execution/{executionId}
擷取批次工作的執行狀態。
非同步/批次
JWT
/adobe/forms/batch/output/config/{configName}/executions
列出特定批次組態的所有執行中執行個體。
非同步/批次
JWT
/adobe/forms/doc/v1/generatePDFOutput
根據範本和資料同步產生PDF輸出。
同步
JWT
/adobe/forms/doc/v1/generatePrintedOutput
產生可供列印的輸出格式(例如PCL、PostScript)。
同步
JWT
/adobe/forms/doc/v1/generate/afp
為大量列印產生AFP輸出。
同步
JWT
/adobe/document/generate/pdfform
轉譯含有合併資料的PDF表單(XFA/XDP)。
同步
OAuth
/adobe/document/generate/pdfform/jobs/{id}/status
擷取PDF表單產生工作的狀態。
同步
OAuth
/adobe/document/generate/pdfform/jobs/{id}/result
擷取已完成的PDF表單作業的輸出/結果。
同步
OAuth

Document Manipulation API

API端點
說明
執行模型
驗證方法
/adobe/forms/assembler/ddx/invoke
執行DDX指令以組合、分割或操控PDF。
同步
JWT
/adobe/forms/assembler/pdfa/convert
將PDF檔案轉換為PDF/A格式。
同步
JWT
/adobe/forms/assembler/pdfa/validate
驗證PDF是否符合PDF/A標準
同步
JWT

檔案轉換API

API端點
說明
執行模型
驗證方法
/adobe/document/convert/pdftoxdp
將PDF表單轉換為XDP格式。
同步
OAuth

檔案擷取API

API端點
說明
執行模型
驗證方法
/adobe/forms/doc/v1/extract/pdfproperties
從PDF中擷取屬性和結構資訊。
同步
OAuth
/adobe/forms/doc/v1/extract/usagerights
擷取內嵌於PDF中的使用許可權。
同步
OAuth
/adobe/forms/doc/v1/extract/metadata
擷取中繼資料,例如標題、作者和關鍵字。
同步
OAuth
/adobe/forms/doc/v1/extract/data
從PDF forms擷取表單資料(XML/JSON)。
同步
OAuth
/adobe/document/extract/security
擷取安全性設定,例如許可權和加密。
同步
OAuth

Document Transformation API

API端點
說明
執行模型
驗證方法
/adobe/document/transform/metadata
在PDF檔案中更新或新增中繼資料。
同步
OAuth
/adobe/document/field/signature/add
將數位簽名欄位新增至PDF。
同步
OAuth
/adobe/document/field/signature/clear
清除簽名欄位的內容。
同步
OAuth
/adobe/document/field/signature/remove
從PDF移除簽名欄位。
同步
OAuth

檔案Assurance API

API端點
說明
執行模型
驗證方法
/adobe/document/assure/usagerights
將使用許可權套用至PDF (例如,註解、填寫、簽署)。
同步
OAuth
/adobe/document/assure/encrypt
使用密碼或憑證安全性來加密PDF。
同步
OAuth
/adobe/document/assure/decrypt
解密受保護的PDF檔案。
同步
OAuth
/adobe/document/assure/sign
數位簽署PDF檔案。
同步
OAuth
/adobe/document/assure/certify
使用數位憑證來認證PDF。
同步
OAuth

相關步驟

瞭解如何設定同步(隨選)和非同步(批次) Forms Communications API的環境:

同步API

AEM Forms Communications API — 同步

瞭解如何設定同步(隨選) Forms Communications API的環境,以便立即產生或處理檔案。

了解更多

非同步API

AEM Forms Communications API — 非同步(批次)

瞭解如何為非同步(批次) Forms Communications API設定環境,以排程方式產生或處理多個檔案。

了解更多

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