AEM Formsas a Cloud Service通訊API frequently-asked-questions

主圖影像

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

通訊功能可協助您建立品牌核准的、個性化的和標準化的文件,例如業務信函、報表、索賠處理函、福利通知、每月帳單或歡迎套件。

該功能提供 API 來產生和操控文件。您可以隨需產生和操控文件,或建立批次作業以按定義的時間間隔產生多個文件。通訊 API 提供:

  • 簡化的隨需和批次文件產生功能。

  • 能夠隨需合併、重新排列和驗證 PDF 文件。

  • 用於輕鬆地與外部系統整合的 HTTP API。包括個別的 API 用於隨需 (低延遲) 和批次操作 (高輸送量操作)。

  • 安全存取資料。通訊 API 僅連接到客戶指定的資料存放庫並從中存取資料,從而使通訊高度安全。

檔案產生

通訊文件產生 API 可協助將範本 (XFA 或 PDF) 與客戶資料 (XML) 相結合,以產生 PDF 和列印格式 (例如 PS、PCL、DPL、IPL 和 ZPL 格式) 的文件。這些 API 使用 PDF 和 XFA 範本搭配 XML 資料以產生單一隨需文件或使用批次作業產生多個文件。

通常,您使用 Designer 建立範本,並使用通訊 API 將資料與範本合併。您的應用程式可以將輸出文件傳送到網路印表機、本機印表機或儲存系統進行封存。典型的立即可用和自訂工作流程如下所示:

通訊文件產生工作流程

視使用案例而定,您也可以讓這些文件可透過網站或儲存伺服器下載。

一些文件產生 API 範例:

建立 PDF 文件 create-pdf-documents

您可以使用文件產生 API 建立根據表單設計和 XML 表單資料的 PDF 文件。輸出是非互動式 PDF 文件。也就是說,使用者不能輸入或修改表單資料。基本的工作流程是將 XML 表單資料與表單設計合併以建立 PDF 文件。下圖顯示將表單設計與 XML 表單資料合併以產生 PDF 文件。

建立 PDF 文件
圖:建立 PDF 文件的典型工作流程

建立 PostScript (PS)、印表機命令語言 (PCL)、Zebra 列印語言 (ZPL) 文件 create-PS-PCL-ZPL-documents

您可以使用檔案產生API來建立以XDP表單設計或PDF檔案為基礎的PostScript (PS)、印表機命令語言(PCL)和Zebra列印語言(ZPL)檔案。 這些 API 可協助將表單設計與表單資料合併以產生文件。您可以將文件儲存到檔案和開發自訂流程將其傳送到印表機。

處理批次資料以建立多個文件 processing-batch-data-to-create-multiple-documents

您可以使用文件產生 API 為 XML 批次資料來源中的每筆記錄建立單獨的文件。您可以採大量和同步模式產生文件。您可以設定各種轉換參數,然後開始批次處理。

建立 PDF 文件

檔案操作

通訊檔案操作(檔案轉換) API有助於組合、重新排列PDF檔案。 通常,您會建立一個 DDX 並將其提交給文件操控 API 以組合或重新排列文件。DDX 文件提供了有關如何使用來源文件產生一組所需文件的說明。DDX 參考文件提供關於所有支援之作業的詳細資訊。部分文件操控範例:

組合 PDF 文件

您可以使用文件操控 API 將兩個或更多 PDF 或 XDP 文件組成單一 PDF 文件或 PDF 組合。以下是組裝PDF檔案的一些方法:

  • 組合一個簡單 PDF 文件
  • 建立 PDF 組合
  • 組合加密的文件
  • 使用貝茨編號 (Bates numbering) 組合文件
  • 扁平化及組合文件

將多個 PDF 文件組合成一個簡單 PDF 文件
圖:將多個 PDF 文件組合成一個簡單 PDF 文件

分解 PDF 文件

您可以使用文件操控 API 來分解 PDF 文件。API 可以從來源文件擷取頁面或根據書籤分隔來源文件。通常,如果 PDF 文件最初是從許多個別的文件 (例如報表集合) 建立的,則此作業很有幫助。

  • 從來源文件擷取頁面
  • 根據書籤分隔來源文件

根據書籤將一個來源文件分隔成多個文件
圖:根據書籤將一個來源文件分隔成多個文件

NOTE
AEM Forms提供多種內建字型,可與PDF檔案緊密整合。 若要檢視支援字型的清單, 按一下這裡.

檔案擷取

檔案擷取功能屬於早期採用者計畫。 您可以從您的官方電子郵件ID寫信到aem-forms-ea@adobe.com ,以加入率先採用者計畫並請求存取該功能。

檔案擷取服務可讓您取得PDF檔案的屬性,例如使用許可權、PDF屬性和中繼資料。 檔案擷取功能包括:

  • 取得PDF檔案的屬性,例如PDF是否具有附件、註解、Acrobat版本等等。
  • 擷取PDF檔案中啟用的使用許可權,使用者會擷取在PDF檔案中啟用或停用的使用許可權,以利進行Adobe Acrobat Reader擴充。
  • 取得PDF檔案中出現的中繼資料資訊,中繼資料是檔案的相關資訊(與檔案的內容(例如文字和圖形)有所區別)。 Adobe可延伸中繼資料平台(XMP)是處理檔案中繼資料的標準。 「XMP公用程式」服務可以從PDF檔案中擷取XMP中繼資料,並將XMP中繼資料匯出到PDF檔案中。

API參考檔案 會提供API提供之所有引數、驗證方法和服務之相關詳細資訊。 API參考檔案也以.yaml格式提供。 您可以下載.yaml並將其上傳到Postman以檢查API的功能。

檔案轉換

轉換為 PDF/A 相容文件並進行驗證

通訊檔案轉換API有助於將PDF檔案轉換為PDF/A。您可以使用這些API將PDF檔案轉換為符合PDF/A的檔案,也可以判斷PDF檔案是否符合PDF/A。 PDF/A是一種用於長期儲存檔案內容的封存格式。 字體內嵌在文件中,檔案未壓縮。因此,PDF/A 文件通常比標準 PDF 文件大。此外,PDF/A 文件不包含音訊和視訊內容。

將PDF轉換為XDP convert-pdf-to-xdp

轉換PDF為XDP的功能屬於早期採用者計畫。 您可以從您的官方電子郵件ID寫信到aem-forms-ea@adobe.com ,以加入率先採用者計畫並請求存取該功能。

將PDF檔案轉換為XDP檔案。 若要將PDF檔案成功轉換成XDP檔案,PDF檔案必須在字典中包含XFA資料流。

檔案保證 doc-assurance

DocAssurance服務包含簽名和加密API:

簽名API

簽名 API 可讓您的組織保護所分發和接收 Adobe PDF 文件的安全和隱私。 安全功能會套用至檔案本身,檔案在其整個生命週期中會保持安全及受控。 當檔案離線下載以及將它送回您的組織時,防火牆外仍會保持安全。 您可以使用簽名API完成以下任務:

  • 將可見簽名欄位新增至PDF檔案。
  • 將不可見的簽名欄位新增到PDF檔案中。
  • 在PDF檔案中簽署指定的簽名欄位。
  • 認證PDF檔案

加密API

加密API可讓您加密和解密檔案。 檔案加密後,其內容會變得無法讀取。 授權的使用者可以解密檔案以取得內容的存取權。 如果PDF檔案已使用密碼加密,使用者必須先指定開啟的密碼,才能在Adobe Reader或Adobe Acrobat中檢視檔案。

您可以使用加密API完成這些工作:

  • 使用密碼加密PDF檔案。
  • 從PDF檔案中移除密碼式加密。
  • 擷取套用至PDF檔案的安全性型別。
  • 傳回套用至PDF檔案的安全性型別。

簽名API和加密API都是 同步API.

檔案公用程式 doc-utility

具有同步API的檔案公用程式可協助您在PDF和XDP檔案格式之間轉換檔案。 將使用許可權套用至檔案,並從檔案中擷取啟用的使用許可權。 查詢PDF檔案的相關資訊。 使用許可權API的詳細資訊如下:

使用許可權API (Reader擴充功能)

使用許可權(Reader擴充功能)功能受限於早期採用者計畫。 您可以從您的官方電子郵件ID寫信到aem-forms-ea@adobe.com ,以加入率先採用者計畫並請求存取該功能。

使用許可權功能可透過擴充具有其他使用許可權的Adobe Reader功能,讓您的組織輕鬆共用互動式PDF檔案。 此服務可與Adobe Reader 7.0或更新版本搭配使用,且會將使用許可權新增至PDF檔案。 此動作會啟動在使用Adobe Reader開啟PDF檔案時通常無法使用的功能,例如新增註釋至檔案、填寫表單和儲存檔案。

當PDF檔案新增了適當的使用許可權時,收件者可以在Adobe Reader中執行下列活動:

  • 線上上或離線完成PDF檔案和表單,讓收件者可在本機儲存復本以做為記錄,同時仍完整保留新增的資訊。
  • 將PDF檔案儲存至本機硬碟,以保留原始檔案及任何其他註解、資料或附件。
  • 將檔案和媒體剪輯附加至PDF檔案。
  • 使用業界標準的公開金鑰基礎結構(PKI)技術套用數位簽名,簽署、認證和驗證PDF檔案。
  • 以電子方式提交已完成或附註的PDF檔案。
  • 使用PDF檔案和表單作為內部資料庫和Web服務的直覺式開發前端。
  • 與其他人共用PDF檔案,讓檢閱者可以使用直覺式的標籤工具來新增註解。 這些工具包括電子註解、印章、醒目提示和文字刪除線。 Acrobat提供相同功能。
  • 支援條碼Forms解碼。

在Adobe Reader中開啟版權啟用的PDF檔案時,這些特殊的使用許可權功能會自動啟用。 當使用者完成使用已啟用許可權的檔案時,這些功能在Adobe Reader中會再次停用。 除非使用者收到其他已啟用許可權的PDF檔案,否則這些功能會維持停用狀態。

啟用或停用使用許可權

擴充PDFReader服務的各種使用許可權功能包括:

  • 條碼解碼:解碼PDF檔案中的條碼。

  • 註解:若要在PDF檔案上離線註解。

  • 線上註解:若要在PDF檔案上線上上加上註解。

  • 數位簽名:將數位簽名新增至PDF檔案。

  • 動態表單欄位:新增表單欄位至PDF檔案的方式。

  • 動態表單頁面:將表單頁面新增至PDF檔案。

  • 內嵌檔案:在PDF檔案中內嵌檔案。

  • 表單資料匯入:將表單資料匯入PDF檔案。

  • 表單資料匯出:將表單資料匯入PDF檔案。

  • 表單填寫:在PDF檔案中填寫表單欄位。

  • 線上Forms:從PDF檔案存取Web服務或資料庫。

  • 獨立提交:從PDF檔案離線提交表單資料。

其他功能

  • 訊息:開啟PDF檔案並套用一或多個使用許可權時,Adobe Acrobat Reader中顯示的訊息。
  • 解鎖密碼:開啟加密的PDF檔案所需的密碼。 通常這是檔案開啟密碼,但如果PDF檔案受到許可權密碼的額外保護,則其中之一可能用於開啟檔案。

API參考檔案 提供API提供的所有引數、驗證方法和各種服務的詳細資訊。 API參考檔案也以.yaml格式提供。 您可以下載.yaml並將其上傳到Postman以檢查API的功能。

通訊 API 類型 types

通訊提供用於隨需和批次產生文件的 HTTP API:

  • 同步 API 適用於隨需、低延遲和單筆記錄文件產生案例。這些 API 更適合根據使用者動作的使用案例。例如,在使用者填寫完表單後產生文件。

  • 批次 API (非同步 API) 適用於已排程、高輸出量和多文件產生案例。這些 API 批次產生文件。例如,每個月都會產生電話帳單、信用卡對帳單和福利對帳單。

上線

通訊功能可作為獨立和附加模組供 Forms as a Cloud Service 使用者使用。您可以聯絡Adobe銷售團隊或您的Adobe代表以要求存取權。 Adobe 為您的組織啟用存取權,並向您指定的組織管理員提供所需的權限。管理員可以授與您as a Cloud Service的Forms開發人員(使用者)存取權以使用這些API。

上線後,若要為您的Formsas a Cloud Service環境啟用通訊功能:

  1. 登入 Cloud Manager 並開啟您的 AEM Forms as a Cloud Service 執行個體。

  2. 開啟「編輯方案」選項,前往「解決方案和附加元件」索引標籤,然後選擇​ Forms - 通訊 ​選項。

    通訊

    如果您已經啟用​ Forms - 數位註冊 ​選項,則選擇​ Forms - 通訊附加元件 ​選項。

    附加元件

  3. 按一下​ 更新

  4. 執行建置管道。建置管道成功後,將為您的環境啟用通訊 API。

NOTE
若要啟用及設定檔案操作API,請將下列規則新增至 Dispatcher設定
# Allow Forms Doc Generation requests
/0062 { /type "allow" /method "POST" /url "/adobe/forms/assembler/*" }

另請參閱 see-also

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