[AEM Forms]{class="badge positive" title="AEM Formsに適用)。"}

AEM Forms Communications API – 概要

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

AEM Forms APIは、構造化されており、次の2つの主要コンソールからアクセスできます。

  • Adobe Developer Console (ADC) ​ - Adobe Developer Consoleは、Adobe API、Events、Runtime、およびApp Builderへのゲートウェイです。

  • AEM Developer Console - AEM Developer Consoleでは、環境レベルの詳細、設定、テクニカルアカウント、サービス資格情報へのアクセス権を提供し、運用タスクと統合タスクをサポートします。

異なるAPIは、異なる認証方法をサポートしています。

認証方法

様々なForms APIでは、リリースタイムラインに基づいて様々な認証方法を使用します。

以前のAPIでは、AEM Developer Consoleを通じて設定および管理されるJWT ベースのサーバー間認証をサポートしていました。 新しいAPIでは、OAuth Server-to-Server認証を使用し、Adobe Developer Consoleを通じて設定します。

API分類の概要

すべてのAEM Forms APIは、次の2つの主要な部分に分かれています。

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

AEM Forms Communications 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 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