1. アプリケーション・コンポーザを使用したアプリケーションの構成
  2. RESTエンドポイントの登録
機械翻訳について

RESTエンドポイントの登録

アプリケーション・コンポーザで使用するGroovyスクリプトには、内部webサービスと外部Webサービスの両方に対するコールを含めることができます。 スクリプトでコールするwebサービスごとに、まずアクセスするRESTエンドポイントを登録する必要があります。

Webサービス参照の作成

webサービス参照を作成するには、アプリケーション・コンポーザで次の手順を実行します:

  1. アクティブなサンドボックス・セッションにいることを確認します。

  2. アプリケーション・コンポーザの共通設定で、「Webサービス」をクリックします。

  3. 「Webサービス参照の作成」アイコンをクリックします。

  4. REST、OKの順に選択します。

  5. このwebサービス参照の名前を入力します。

    この名前は、「式ビルダーのWebサービス」タブのwebサービスのリストで使用される識別子です。

  6. 統合するwebサービスのファイルのロケーションURLを指定します。

  7. 認証スキームを選択する場合は、必要な情報を指定します。 webサービスとのセキュアな通信のために、様々なスキームを使用してユーザー資格証明を認証し、セキュリティを確保できます。 Groovyスクリプトのwebサービスでは、次のスキームがサポートされています:

    • なし

      セキュリティ・スキームを使用しないことを指定するには、このオプションを選択します。

    • 基本認証を使用して起動

    • SSL経由でSAMLを使用してユーザー・アイデンティティを伝播

    • SAMLを使用してユーザー・アイデンティティを伝播

    • OAUTHを使用して起動

      Oracle以外のwebサービス・エンドポイントでこのスキームを使用しないでください。 このスキームは現在、Oracle Cloud OAuthサーバーで保護されているリソースのみをサポートしています。

    ユーザー名とパスワード資格証明を必要とするセキュリティ・スキームの場合は、資格証明キーを指定します。 webサービス・プロバイダは、特定のWebサービスに使用する必要がある資格証明について通知します。

  8. 次に、リソースに対してメソッドを選択および構成します。 リソース操作(GET、POSTなど)および関連するペイロード書式タイプ(JSON/XML)を登録できます。 登録された操作のみがGroovy式ビルダーに表示されます。

    選択

    説明

    方法タイプ

    式ビルダーで公開するメソッド・タイプのチェック・ボックスを選択します。

    • GET

    • PUT

    • POST

    • PATCH

    • DELETE

    公開するメソッドごとに、次の情報を指定します。

    メソッド名

    選択したメソッドの名前がここに表示されます。 デフォルトでは、メソッド・タイプ(POSTなど)と同じですが、変更できます。

    書式

    選択したwebサービスが戻す内容に基づいて、メソッドの形式を選択します。

    • XML

    • JSON

    この情報は、webサービス・プロバイダまたはWebサービスのドキュメントによって提供されます。

    要求ペイロード

    必要に応じて、ペイロードのオブジェクト構造を指定します。 これは、次のいずれかの方法で実行できます:

    • オブジェクト構造を表すスキーマURLを直接指定します。

    • JSONまたはXML形式のコード・サンプルを指定します。 これは、式ビルダーで参照ヒントを表示する場合に役立つオプションのパラメータです。

      JSONコード・サンプルを取得するには、PostmanなどのRESTクライアントを使用して外部からAPIを実行します。 Postman実行の要求ペイロードは、このコード・サンプル・パラメータのリクエスト・ペイロードを形成します。

    このセクションはオプションです。

    応答ペイロード

    メソッドがレスポンス(GETなど)を返す場合、レスポンス・ペイロードを返すレスポンス・オブジェクト構造を指定します:

    • スキーマURL

      データの構造を提供するが、値を含まないURL。

    • コード・サンプル

      使用可能なスキーマがない場合は、このオプションを選択し、サンプル・レスポンス(サービス・ドキュメントなど)をJSONまたはXML形式でこのフィールドに貼り付けることができます。 このパラメータは、式ビルダーで参照ヒントを表示する場合に役立ちます。

      JSONコード・サンプルを取得するには、PostmanなどのRESTクライアントを使用して外部からAPIを実行します。 Postman実行のレスポンス・ペイロードは、このコード・サンプル・パラメータのレスポンス・ペイロードを形成します。

    ノート:

    「レスポンス・ペイロード」フィールドにエントリを含める必要があります。 そうしない場合、Groovyはレスポンス・ペイロードのかわりにnullを返します。 レスポンス・ペイロードを含めない場合は、JSONの場合は{ }、コード・スキーマ・サンプルとしてXMLの場合は<a/>を入力します。

既存のwebサービス参照をいつでも編集して、使用するセキュリティ・スキームや特定のセキュリティ・スキームに使用される設定を変更できます。

webサービス参照を作成すると、式ビルダーの「Webサービス」タブで使用可能なリストにWebサービスの名前が表示されます。 リストからwebサービスを選択すると、Groovyスクリプトで使用するWebサービスが提供する任意の機能を選択できます。

ヒント:

webサービス参照を管理する場合は、「Webサービス」ページの「リフレッシュ」アイコンをクリックして、リストが最新であることを確認します。 「リフレッシュ」をクリックする必要がある場合の詳細は、後述の「Webサービス参照のリストのリフレッシュ」を参照してください。

Webサービス参照のリストのリフレッシュ

webサービスに対して新しいメソッドが追加された場合、Webサービス参照が更新されるように、「Webサービス」ページの「リフレッシュ」アイコンをクリックする必要があります。 そうしないと、式ビルダーで新しいメソッドをwebサービスで使用できなくなります。

リフレッシュ・アイコンは、クライアントとのサービス契約が変更されるたびに適用されます。 これにより、既存のメソッドのシグネチャを変更したり、既存のメソッドを削除したりする新しいメソッドが生成される可能性があります。

「リフレッシュ」をクリックして、別のユーザー・セッションで作成された新しいwebサービス参照を表示することもできます。

セキュリティの構成

関連付けられたサービス・エンドポイントまたは関連付けられていないサービス・エンドポイントへのwebサービス参照を作成するかどうかに応じて、セキュリティを異なる方法で構成します。

同じアイデンティティ・ドメインに存在するOracle Java Cloud Service - SaaS Extensionなど、関連付けられたサービス・エンドポイントへのwebサービス参照を作成する場合、SSO有効化を含む必要な設定はアソシエーション中に完了します。

  • 関連付けの詳細は、Oracle Cloud Oracle Cloudの管理およびモニタリング(http://docs.oracle.com/en/cloud/get-started/subscriptions-cloud/mmocs/managing-associations-services.html)を参照してください。

    Oracle SaaSとOracle PaaS (JCS-SaaS Extension)の間でユーザーを同期するには、https://docs.oracle.com/en/solutions/embed-java-saas-extension-app-in-sales-cloud/synchronizing-oracle-sales-cloud-oracle-hcm-cloud-and-oracle-erp-cloud-user-identities-and-roles-sim.html#GUID-C3F3348C-8C74-4F17-B9CE-0893CE2FA7CCのステップを確認します。

関連付けられていないサービス・エンドポイント(おそらくnon-Oracle Cloudサービス)へのwebサービス参照を作成する場合は、次の設定を実行します:

  • サーバーのCA SSL証明書をサービス・プロバイダから取得します。 自己署名証明書を使用しないでください。

  • OPSSキーストア・サービスに証明書を追加します。 キーストア・サービスを使用すると、SSL、メッセージ・セキュリティ、暗号化および関連タスクのキーおよび証明書を管理できます。 キーストア・サービスを使用して、キー、証明書およびその他のアーティファクトを含むキーストアを作成および保守します。

    顧客証明書のインポートは必要ありません。

  • セキュアな接続(https)を使用し、デフォルト・ポート(443)を使用します。

  • 基本認証が不要な場合は、SAML over SSL認証スキームを使用します。

    Oracle Single Sign-Onの詳細は、Oracle Cloudアイデンティティの概念の理解ガイド(http://docs.oracle.com/en/cloud/get-started/subscriptions-cloud/ocuid/oracle-single-sign.html#GUID-379DAC22-B3AC-4957-AF60-D45A07CC8598)を参照してください。

セキュリティ設定エラーの解決

一部のセキュリティ設定が実行されていない場合は、webサービスがGroovyスクリプトからコールされたときにエラーが表示されることがあります。

  • メッセージ保護が使用されている場合の不正な暗号化エラー

  • メッセージ保護セキュリティが使用されている場合のPolicyEnforcementExceptionエラー。

エラーを解決するには、Oracle Supportを使用してサービス・リクエストを作成する必要があります。 サーバーの暗号化証明書と発行者証明書をサービス・プロバイダから取得し、両方をサービス・リクエストに、ロケーションとエラーの詳細とともに添付します。

アプリケーションの変更の移動

ソース環境で行ったアプリケーション変更をダウンロードし、ターゲット環境にアップロードできます。 これにより、複数の環境でアプリケーション変更を操作する際に時間を節約できます。

これを行うには、次の手順を実行します:

  1. 「構成セット移行」ページを使用して、アプリケーション環境に対するすべての変更および拡張のセットを作成します。

  2. 続いて、その構成セットをダウンロードし、別の環境にアップロードします。

    多くの場合、これは構成セットの移行(CSM)と呼ばれます。

ただし、ソース環境のアプリケーション・コンポーザで作成されたwebサービス参照は、移行後にターゲット環境で機能しません。 したがって、構成セットをターゲット環境にアップロードした後、ターゲット環境でアプリケーション・コンポーザを使用してwebサービス参照を再作成する必要があります。

移行プロセス中に、2つの環境間でアプリケーションの変更を比較することもできます。 これを行うには、構成デルタ・レポートを使用します。 このレポートを使用すると、構成の違いを確認できるため、ある環境で発生するが別の環境では発生しない問題を簡単にトラブルシューティングできます。 詳細は、「構成の移行」を参照してください。

関連トピック