チャレンジ
Pega APIを使用したPegaアプリケーションへのアクセス
Pega APIを使用したPegaアプリケーションへのアクセス
2 タスク
5 分
中級
データ統合
DX API
日本語
シナリオ
TGBのHR部門では、外部システムがPegaアプリケーションで従業員評価ケースを自動的に作成できるようにすることで、従業員評価プロセスを近代化したいと考えています。 現在、評価リクエストは手動で開始されます。効率性を向上させるために、TGBはPega APIを使用した外部サービスからEmployee Evaluationケースを作成できるようにしたいと考えています。これにより、他のシステムが評価プロセスを自動的にトリガーできるようになります。 安全なAPI認証を使用して外部サービスからのケース作成リクエストを受け入れるようにシステムを設定します。
これを完了するため、以下のリストには、このアサインメントを完了するための推奨タスクが含まれています。
- 外部サービスアクセス用のOAuth 2.0認証を設定する
- ケース作成用の安全なAPIログイン情報を設定する
- Pega API経由で外部ケース作成をテストする
補足： この演習では、外部アプリケーションを開発する方法については説明していません。目標は、Pegaアプリケーションへのアクセスに必要なPega APIと、その結果としてのJSONレスポンスを示すことです。
以下の表は、チャレンジに必要なログイン情報をまとめたものです。
| ロール | ユーザー名 | パスワード |
|---|---|---|
| シニアシステムアーキテクト | SSA@TGB | pega123! |
補足： このチャレンジにはデモビデオはありません。チャレンジを完了するための段階的な手順については、「詳細なタスク」を参照してください。
詳細なタスク
1 外部サービスアクセス用のOAuth 2.0認証を設定する
- チャレンジのPegaインスタンスに、以下のログイン情報を入力します。
- User nameフィールドに「SSA@TGB」と入力します。
- Passwordフィールドに「pega123!」と入力します。
- Dev Studioで「Create > Security > OAuth 2.0 Client Registration」をクリックします。
- OAuth 2.0 Client Registration short descriptionおよびClient nameフィールドの両方で「EmployeeEvalutionAuthentication」と入力します。
- 「Create and open」をクリックします。
補足： DX API V2のテストには認証ログイン情報が必要です。エンドポイント呼び出しに対するサンプル応答を生成するには、OAuth 2.0クライアント登録データインスタンスが必要です。
- レコードを設定する
- Supported grant typesセクションで、「Client credentials 」チェックボックスをオンにして、Access groupラジオボタンを選択します。
- Access groupフィールドに「HRAppsV2:Administrators」と入力するか、これを選択します。
- Client Credentialsセクションで、「View & download」をクリックします。
- 「View & download」ウィンドウで、「Download credentials」をクリックします。
- EmployeeEvalutionAuthentication_Client Credentialsファイルがマシンにダウンロードされたことを確認します。
- View & downloadウィンドウを閉じます。
- レコードのヘッダーで、「Save」をクリックします。
補足： レコードを保存した後、ログイン情報をダウンロードするオプションは無効になります。
2 ケース作成用の安全なAPIログイン情報を設定してPega APIをテストする
- Dev Studioの右上隅で、「Resources > Pega API」をクリックして、Pega APIランディングページを開きます。
- Service packageリストで「Constellation DX APIs」を選択します。
- Applicationセクションで、「Authorize」をクリックします。
- 前のタスクでダウンロードして保存したEmployeeEvalutionAuthentication_ClientCredentials.txtファイルを開きます。
- Available authorizationsウィンドウのClientCredentials (OAuth2, clientCredentials)セクションのclient_idとclient_secretフィールドで、値を入力するか、テキストファイルからコピーして貼り付けます。
- 「Authorize 」をクリックして、承認が成功したことを確認します。
- 「Close」をクリックして、Available authorizationsウィンドウを閉じます。
- ケースセクションで、「/cases」の右側にある「POST /cases」APIエンドポイントを拡張して新しいケースを作成します。
- 「Try it out」をクリックします。
- REQUEST BODYに以下のJSONをコピーして貼り付けます。
{
"caseTypeID":"TGB-HRApps-Work-EmployeeEvaluation",
"parentCaseID": "",
"processID": "pyStartCase",
"content": {
"Employee": {
"pyFirstName":"Mario",
"pyLastName":"Rossi",
"Manager":"SSA@TGB",
"Department":"Consulting"
},
"StartDate":"20300601",
"EndDate":"20301231"
},
"pageInstructions": [],
"attachments": []
}補足： JSONで提供される従業員の詳細をメモします。 -
「Execute」をクリックして新しいケースを作成します。
-
結果のJSONレスポンスを確認します。Response Bodyセクションにアクセスし、生成されたケースIDをメモします。
補足： JSONレスポンスは読み取りにくい可能性があります。読み取りやすくするために、ブラウザー用のJSONビューアプラグインをダウンロードしてみてください。
このモジュールは、下記のミッションにも含まれています。
トレーニングを実施中に問題が発生した場合は、Pega Academy Support FAQsをご確認ください。