同期処理を使用

通信サービスでは、ビジネス通信、ドキュメント、声明書、請求処理レター、給付通知、請求処理レター、月次請求書、ウェルカムキットなど、ブランド志向でパーソナライズされたコミュニケーションを作成、組み立て、提供できます。通信 API を使用して、テンプレート(XFA または PDF)と顧客データを組み合わせ、PDF、PS、PCL、DPL、IPL、ZPL 形式のドキュメントを生成できます。

例えば、1 つ以上のテンプレートが存在しており、各テンプレートには XML データの複数のレコードがあるシナリオを考えてみましょう。通信 API を使用して、各レコードの印刷用ドキュメントを生成できます。結果は非インタラクティブ PDF ドキュメントになります。非インタラクティブ PDF ドキュメントのフィールドには、ユーザーがデータを入力することはできません。

通信サービスは、オンデマンドおよびスケジュールされたドキュメント生成用に API を提供します。オンデマンドに同期 API を、スケジュールされたドキュメント生成にバッチ API(非同期 API)を使用できます。

  • 同期 API は、オンデマンド、低遅延および単一レコードドキュメントを生成するユースケースに適しています。これらの API は、ユーザーアクションに基づいたユースケースにより適しています。例えば、ユーザーがフォームに入力した後にドキュメントを生成する場合などです。

  • バッチ API(非同期 API)は、スケジュールに沿った高スループットの複数ドキュメント生成のユースケースに適しています。これらの API は、バッチでドキュメントを生成します。例えば、毎月生成される電話料金、クレジットカード明細、給付計算書などです。

同期操作を使用

同期操作とは、ドキュメントを線形的に生成するプロセスです。別個の API は次の場合に使用可能です。

  • テンプレートから PDF ドキュメントを生成し、そのドキュメントにデータを結合する。
  • XDP ファイルまたは PDF ドキュメントから PostScript(PS)、Printer Command Language(PCL)、Zebra Printing Language(ZPL)ドキュメントを生成する。
  • PDF ドキュメントのアセンブリ
  • PDF ドキュメントのディスアセンブリ
  • 文書をPDF/A 準拠文書に変換する
  • PDF/A 準拠のドキュメントの検証

API 呼び出しの認証

同期操作は、次の 2 種類の認証をサポートします。

(ドキュメント生成 API の場合のみ)アセットと権限の設定

API を使用するために必要なものは、次のとおりです。

  • PDF または XDP テンプレート
  • テンプレートと結合するデータ
  • Experience Manager 管理者権限を持つユーザー
  • テンプレートおよびその他のアセットの Experience Manager Forms Cloud Service インスタンスへのアップロード

(ドキュメント生成 API の場合のみ)テンプレートおよび他のアセットをExperience Managerインスタンスにアップロード

通常、組織には複数のテンプレートがあります。例えば、クレジットカード明細、福利厚生明細、請求申込用にそれぞれ 1 つずつテンプレートがあります。このような XDP および PDF テンプレートをすべて Experience Manager インスタンスにアップロードします。テンプレートをアップロードするには:

  1. Experience Manager インスタンスを開きます。
  2. フォーム/フォームとドキュメントに移動します。
  3. 作成/フォルダーをクリックし、フォルダーを作成します。フォルダーを開きます。
  4. 作成/ファイルをアップロードをクリックし、テンプレートをアップロードします。

API を呼び出す

API から提供されるすべてのパラメーター、認証方法および各種サービスの詳細については、API リファレンスドキュメントを参照してください。また、API リファレンスドキュメントでは、API 定義ファイルを.yaml 形式で提供しています。 .yaml ファイルをダウンロードし、Postman にアップロードして API の機能を確認できます。

メモ

通信 API にアクセスできるのは、forms-users グループのメンバーだけです。

このページ