Pega Digital Experience API

Pega Digital Experienceは、複数のチャネルにわたって一貫性のあるブランドエクスペリエンスを実現します。 Pega Digital Experience（DX）APIは、ケースとアサインメントのプログラムによる表示、作成、更新を可能にする、モデル駆動型のREST APIエンドポイントのセットです。 これにより開発者は、ビジネスロジックを各チャネルにエンコードすることなく、Pega Platform™アプリケーション向けにカスタムのフロントエンドエクスペリエンスを構築できます。 Pega Platformには、Pega Platform以外のユーザーインターフェイスにデータを入力するために使用できるREST APIが用意されています。 応答APIは、UI要素、レイアウト、アクション、およびスタイルを含んでいる点で、従来のAPIとは異なります。

これらのREST APIは、Pega Platformのユーザーインターフェイスルール（ハーネスおよびセクション）とPega Platformのビジネスルールを活用して、ネイティブインターフェイスを使用してレンダリングできるJSON相当の構造を返すため、デジタルエクスペリエンスAPIとして知られています。 たとえば、車両の購入時には、車両の詳細が画面で取り込まれます。 応答APIは、車両の詳細がどのように取り込まれたかに関する詳細をすべて含んでおり、レンダリングUIで同じ詳細を再現します。 

DX APIバージョン2は、主にビューベースのオーサリングに重点を置いています。 このAPIにより、データビューを管理してメタデータを探索し、データビューのエンドポイントを使用して特定のフィールドを取得できます。

リードシステムアーキテクト（LSA）は、アプリケーションがDX APIに準拠していることを確認する必要があります。 そうすることで、開発者は選択したUIシステムで適切なフロントエンドコンポーネントを構築し、お客様とその目標とする成果を中心に据えたCenter-Outアーキテクチャの原則をサポートできます。 以下は、DX APIを使用してアプリケーションを設計する際に考慮すべきガイドラインです。

• ハーネスは、最上位コンテナーとして画面レイアウトを使用する必要があります。
• 表示条件に使用される式は、whenルールへの参照のみで構成されている必要があります。
• セクションは自動生成される必要があります。
• 次のいずれかのレイアウトをセクションで使用する必要があります。
  • テーブル
  • ダイナミックレイアウト
  • リピーティングダイナミックレイアウト（供給元はデータページではない）
  • 組み込みセクション
• 編集可能なページ（名前付きページ、スレッドレベルのデータページ、またはリクエスターレベルのデータページ）をフローアクションで使用する場合、後処理用のデータトランスフォームまたはアクティビティでは編集された値を使用できません。 そのような場合は、自動入力されたプロパティ（データページからデータを取得）と保存可能なデータページのパターンをフローアクションの後処理で使用します。
• アプリケーションは楽観的ロックを使用するよう常に構成する必要があります
• V2 DX APIテストでは、エンドポイント呼び出しに対するサンプル応答を生成するための認可が必要です。 OAuth 2.0クライアント登録データインスタンスが必要です。

DX APIバージョン2には次の拡張機能があります。

•     新しいエンドポイントが導入され、メッセージング構造によってデータとレイアウトが分離されるようになりました。 
•     ビューベースのアプローチを使用するアプリケーションには、App Studioとビューを中心としたDX API v2のメリットがもたらされます。

DX APIのセキュリティ設定

DX APIエンドポイントには安全にアクセスする必要があります。 安全なアクセスは、認証設定とアクセスロール権限によって実現します。
認証設定はサービスパッケージで提供されています。 サービスパッケージで使用可能な認証のタイプは次のとおりです。

• Basic
• OAuth 2.0
• Custom

より安全にエンドポイントにアクセスするには、認証タイプとしてOAuth 2.0を使用します。

アクセスロール権限。エンドポイントはどれも特定の権限にマッピングされています。 対応するエンドポイントに関連したアクションを実行するための特定の権限をユーザーに提供できます。

権限はPegaRULES:PegaAPIアクセスロールに含まれています。 デフォルトで、このロールを使用できるのは管理者と作成者の各アクセスグループのみです。 ユーザーにDX APIへのアクセスを許可するには、そのユーザーのアクセスグループにPegaRULES:PegaAPI アクセスロールを追加します。 追加の権限を付与して、特定のアクションを実行している間にフィールドレベルのセキュリティを有効にすることができます。

DX APIの詳細については、Pega CommunityおよびPega Academyの以下のコンテンツを参照してください。

• DX API Version 2
• Pega User Experience (UX) Essentials
• Creating custom screens with the digital experience APIs

---