AEM Forms Communications API – 概要

AEM Forms API は、ドキュメントワークフローの自動化に役立つように設計された、クラウドネイティブな API の包括的なスイートを提供します。

AEM Forms API は、次の 2 つの主要なコンソールを通じて構造化され、アクセスされます。

  • 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 は、次の 2 つの主な部分に分かれています。

詳細
アダプティブフォーム配信およびランタイム API
通信 API
目的
アダプティブフォームの配信とランタイム操作を処理
ドキュメントの生成と操作
ユースケース
- フォームのレンダリング
- データの事前入力
- フォーム送信
- ドラフト管理
- PDFの生成
– 文書結合
- バッチ処理
– 印刷処理
認証方法
OAuth サーバー間/ユーザー認証方法をサポートします。
API に応じて、サーバーからサーバーへの認証(JWT または OAuth)をサポートします。 1 つの API で両方の認証方法をサポートすることはできません。

AEM Forms通信 API

通信 API は、ドキュメント中心の操作の主な焦点です。

次の表に、すべての AEM Forms Communications API と ​ サポートされる認証方法および実行モデルを示します。

ドキュメント生成 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

ドキュメント操作 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

ドキュメント変換 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

Document 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通信 API の環境を設定する方法について説明します。

同期 API

AEM Forms通信 API – 同期

ドキュメントを即座に生成または処理する、同期(オンデマンド)Forms Communications API の環境を設定する方法を説明します。

詳細情報

非同期 API

AEM Forms通信 API – 非同期(バッチ)

複数のドキュメントをスケジュールに従って生成または処理する、非同期(バッチ)Forms通信 API の環境を設定する方法について説明します。

詳細情報

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