サービスとしてのアプリケーションの公開
アプリケーションをサービスとして公開する最も一般的な方法は、Pega APIを利用する方法と、Service Wizardでウェブサービスを作成する方法の2つです。
概念上は、これらの2つのオプションは、URLに対してリクエストが行われ、レスポンスを受け取ることで同じように動作します。 違いは、サービスとのコミュニケーション方法にあります。
Pega API
Pega APIは、ケースなどのアプリケーションのリソースについて、より一般的な用語でコミュニケーションを取ります。 たとえば、外部アプリケーションがケースの添付のリストを必要とする場合や、ケースの詳細を取得し、その後更新のために呼び出す必要がある場合に、Pega APIを使用します。 複数のPega APIサービスを、単一または複数のアプリケーションプロセスの一部として使用できます。
Pega API は、新規ケースの作成、アサインメントの処理、データページへのアクセスなどの標準サービスを提供します。 これらの内蔵REST/JSONサービスにより、Pegaを搭載したモバイルアプリケーションや顧客のアプリケーションを迅速に実装することができます。
Pega APIサービスは、標準的なHTTPメソッド(たとえばGET、POST、PUTなど)を使用して起動することができます。 リクエストとレスポンスのデータ要件の詳細を確認するには、Dev StudioまたはApp StudioでPega APIリソースページを表示します。
- Dev StudioでResources menu,をクリックし、Pega APIを選択します。
- App StudioでChannelsをクリックし、APIを選択します。
Pega API経由で利用できるリソースは以下のとおりです。
リソース | 機能 |
---|---|
Assignment API | ユーザーの割り当てリストを取得し、特定の割り当ての詳細を取得し、割り当て操作を実行します。 |
Authenticate API | ユーザーのログイン情報を確認します。 |
Cases API | ユーザーケースリストを取得し、新規ケースを作成し、ケースの詳細情報を取得し、特定のケースを更新します。 |
Casetypes API | 認証済みユーザーのケースタイプのリストを取得します。 |
Data API | データページのコンテンツを取得したり、特定のデータページのメタデータを取得したりするプロセスを手助けします。 |
Docs API | Pega APIの完全文書にアクセスします。 |
補足: Pega APIの詳細については、「Integrating with Pega APIs and services」を参照してください。 ドキュメントは、JSON形式でDocs API(GET/docs)でも提供されています。
電気自動車のドライバーが、市が所有する充電器に関する問題を報告する申請のケースについて考えてみましょう。 ユーザーに問題が発生すると、アプリケーションにアクセスし、その問題を報告します。 その後、市の職員がさらなる対応のために問題のレポートを確認します。 Pega APIでのやり取りは以下のとおりです。
- GET /authenticateを呼び出して、アプリにログインします。
- GET /casetypesを呼び出して、レポートに関連する可能性のある問題のリストを表示します。
- GET /data/D_CityRegionListを呼び出して、都市圏のリストを表示します。
- 問題と都市圏を選択します。
- POST /casesを呼び出して、レポートを送信します。
- GET /casesを呼び出して、送信済みのすべてのレポートを表示します。
- GET /cases/IDを呼び出して、特定のレポートを開き、詳細を表示します。
Service Wizard
Pega APIはリソース指向でアクション指向ではないため、外部呼び出し元がPega Platformアプリケーションに特定のイベントが発生したことを通知するなど、特定のアクションを実行する必要がある場合は、Service Wizardを使用してカスタムAPIを構築または使用する必要があります。 カスタムAPIを使用する場合、アプリケーションの実際のデータモデルを使用することで、より具体的にリクエストとレスポンスを定義できます。 外部システム向けにカスタムREST/JSONサービスを作成し、Pega Platformアプリケーションと統合して、データのリクエスト、受信、送信、またはアクションの呼び出しを行うことができます。
たとえば、外部アプリケーションが保険ポリシーの詳細にアクセスし、特定のイベントを処理するようアプリケーションに通知する必要がある場合を考えてみます。 必要なパラメーターを指定してRESTサービスを公開し、それらのポリシーの詳細を含むレスポンスを外部アプリケーションに提供します。
ヒント: どのAPIが必要かを選択する前に、Pega Platform™データモデルに親しみ、Pega APIからのリクエストを正しくフォーマットしてレスポンスを理解するようにしてください。
Configure > Integration > Services > Service WizardをクリックしてService Wizardにアクセスしてください。 Service Wizardは、以下のいずれかのタスクを実行するサービスのルールとデータタイプを生成します。
サービス目的 | 説明 |
---|---|
ワークの作成と管理 | ワークアイテムを新規作成したり、フローアクションなどのワークオブジェクトに対するアクションを実行したりします。 |
既存のアクティビティルールの起動 | アクティビティを起動し、サービスパラメーターを選択します。 |
入力または出力データの処理 | データをクリップボードへ、またはクリップボードからマッピングします。 |
Service Wizardは、これらのタスクを5つの一般的なステップで実行し、適切なサービスルールと対応するデータタイプを定義する一連のフォームを表示します。 サービスの目的によっては、その構成の性質上、より多くのサブステップが含まれる場合があります。 完了後、Service Wizardには指定された値が表示され、サービスルールを作成する前にそれらの設定値を確認および修正できます。
次の画像で+のアイコンをクリックすると、Service Wizardの5つの一般的なステップの詳細が表示されます。
次の問題に答えて、理解度をチェックしましょう。
このトピックは、下記のモジュールにも含まれています。
- ウェブサービス v4
トレーニングを実施中に問題が発生した場合は、Pega Academy Support FAQsをご確認ください。