同期処理を使用 sync-processing-introduction

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

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

Formsas a Cloud Service - コミュニケーションは、スケジュールされたドキュメント生成にオンデマンドおよびバッチ API(非同期 API)を提供します。

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

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

同期操作を使用 batch-operations

同期操作とは、ドキュメントを線形的に生成するプロセスです。これらの API は、シングルテナント API とマルチテナント API に分類されます。

シングルテナント API

  • ドキュメント生成 API
  • ドキュメント操作 API

シングルテナント API の認証

シングルテナント API 操作は、次の 2 種類の認証をサポートしています。

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

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

  • 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 の機能を確認できます。

NOTE
コミュニケーション API にアクセスできるのは、forms-users グループのメンバーだけです。
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab