開発中のテストフロー

App Connect Designerでは、サンプルデータを使用してフローを開発しながらテストできます。 VPC hours プランでは、 フローをデプロイする前に実際のデータでテストすることもできます。

開始前に

フローをテストする前に、そのフローは以下の要件を満たしていなければならない。
  • フローにバリデーションエラーがないこと。 詳細は、 フローの検証を参照。
  • フロー内のすべてのアプリケーションコネクタは、アカウントに接続されている必要があります。 詳細については、 アカウントへの接続を参照してください。

このタスクについて

以下のトピックでは、 App Connect Designer でフローの側面をテストする方法について説明します。 サンプルデータを使用して、フロー内のアクションとマッピング（またはデータ変換）をテストできます。 また、サンプルデータを使ってエンド・ツー・エンドの流れをテストすることもできる。 VPC hours プランをご利用の場合は、 導入前に実際のデータを使ってフローをテストすることもできます。
注意: サンプルまたは実際のデータを使用してフローまたはフロー内のアクションをテストすると、接続しているアプリケーションがそのデータで更新されます。 したがって、接続するアプリケーションがテストに使用するのに適切であることを確認してください。
  • サンプルデータを使用してフロー内のマッピングをテストする場合、サンプルデータはそのフィールドの結果値がどのようになるかを示すために使用されます。 (この種のテストは、あなたが接続しているアカウントのデータには影響しません）
  • サンプルデータを使用してフロー内のアクションをテストする場合、サンプルデータは、アクションがターゲットアプリケーションにどのように影響するかを示すために使用されます。
  • サンプルデータを使用してイベントドリブンまたはAPIフローをテストする場合、フローは一度実行され、サンプルデータを使用してフロー内のターゲットアプリケーションを更新します。
  • 実データを使用してイベント駆動フローをテストする場合、フローは一時的にデフォルトの統合ランタイムにデプロイされ、そこで停止するまで実行される。
  • APIをテストすると、APIは一時的にデフォルトの統合ランタイムにデプロイされ、そこで停止するまで実行される。
ヒント： テスト結果ペインでテスト結果を表示する場合、すべてのプロパティが表示されるわけではありません。 すべての入出力プロパティをJSON形式で表示するには、コード・ビューを使用します。

サンプルデータを使ったマッピングのテスト

自動生成またはカスタムサンプルデータを使用して、フロー内のノードのマッピングとデータ変換をテストできます。

このタスクについて

フィールドをフロー内の前のノードの値にマップすると、そのフィールドの内容を表すサンプルデータを見ることができます。 そのマッピングにJSONataを適用すると、サンプルデータが変換されて結果が表示される。
マッピングがJSONataによってどのような影響を受けるかを示すサンプルデータ
ヒント: フィールドのマッピングと変換のテストは、フローエディタでフィールドに表示されるサンプルデータにのみ影響します。 この種のテストは、接続しているアプリケーションには影響しない。

手順

入力フィールドのマッピングと変換をテストするためにサンプル・データを使用するには、以下の手順を実行します。

  1. テストしたいフローをApp Connect Designerで開きます.
  2. フローエディターで、フロー内のノードを選択し、サンプルデータをクリックします。
    Shopifyの顧客作成アクションのサンプルデータリンク。
    あるいは、フィールドを選択してから編集をクリックすると、選択したフィールドのサンプルデータにフォーカスを当てたコンテキストとサンプルデータペインが開きます。
    入力フィールドのサンプルデータが表示され、編集リンクも提供されます。
    フィールドに複数のマッピングがある場合は、マッピングをクリックして、メニューからサンプルデータの編集を選択することもできます。
    フィールドの変換内のマッピングのサンプルデータオプションを編集する
    コンテキストとサンプルデータペインが開くと、フロー内の前の各ノードのフィールドを展開できます。 サンプルデータの初期セットはフィールドタイプによって異なる：
    • 文字列フィールドのサンプルデータ値は SampleFieldName です。
    • 整数フィールドの値は 1 です。
    • ブール値フィールドの値は true です。
    • 日付フィールドの値は1985-04-12T23:20:50.52Zです。
    コンテキストとサンプルデータ] ペインには、Salesforce の新規リードのフィールドのリストが表示されます。 各フィールドのサンプル値が表示されます。 例えば、リードIDフィールドのサンプルデータはSampleLeadIDです。
  3. コンテキストとサンプルデータペインでは、サンプルデータのフィールドを独自のカスタム値で編集することができます。 あるいは、サンプルデータの再生成をクリックすると、名前、住所、ID番号など、より現実的なサンプル値のセットが自動的に生成されます。
    自動生成されたサンプルデータの結果

    Context and sample data ペインのサンプルデータに加えた変更は、そのノードのサンプルデータに即座に反映されます。 この変更は、そのマッピングを参照するフロー内の後のノードにも反映される。 これらの変更は、フローエディターが開いている間持続します。 マッピングにJSONata関数を適用した場合、サンプルデータは関数の結果を示すように変換されます。

  4. Context と Sample data ペインを閉じるには、 Close 閉じるアイコン または Sample data のどちらかをクリックします。
    コンテキストとサンプルデータペインを閉じるには、ペイン上で閉じるをクリックするか、再度サンプルデータをクリックします。

サンプルデータを使ったアクションのテスト

ターゲットアプリケーションに対するアクションの効果をテストするには、サンプルデータでアクションをトリガーし、アプリケーションが返すテスト結果を確認する。

このタスクについて

注意:この方法でアクションをテストすると、接続しているターゲットアプリケーションのアクションが完了します。 テストの前に、アクションの接続アカウントがテストに適切であることを確認する。 テスト用に1つのアカウントを使用し、フローをデプロイするときに別のアカウントを使用することができます。
サンプルデータを使用して、フローで以下のアクションをテストできます：
  • Salesforce "Create lead "アクションなど、 App Connect Applications and APIsページでアカウントを作成したアプリケーションのすべてのアクション
  • App Connectの アプリケーションとAPIページで接続しているすべてのAPI
  • ツールボックスタブのログノード
フローでアクションをテストする場合、そのアクションは一度だけ完了する。 サンプルデータを使用してフロー内のすべてのアクションをテストするには、 サンプルデータを使用してフローをテストするを参照してください。

フロー内のアクションをテストするには、アクションが適切なアカウント (Salesforce 開発者アカウントなど) に接続されていることを確認します。 そして、あなたのアクションにバリデーションエラーがないことを確認してください。

手順

アクションの設定をテストするには、以下の手順を実行する。

  1. テストしたいフローをApp Connect Designerで開きます.
  2. フローエディターで、フロー内のアクションノードを選択し、サンプルデータをクリックします。
    Shopifyの顧客作成アクションのサンプルデータリンク。
    コンテキストとサンプルデータペインが開くと、フロー内の前の各ノードのフィールドを展開できます。 サンプルデータの初期セットはフィールドタイプによって異なる：
    • 文字列フィールドのサンプルデータ値は SampleFieldName です。
    • 整数フィールドの値は 1 です。
    • ブール値フィールドの値は true です。
    • 日付フィールドの値は1985-04-12T23:20:50.52Zです。
    コンテキストとサンプルデータ] ペインには、Salesforce の新規リードのフィールドのリストが表示されます。 各フィールドのサンプル値が表示されます。 例えば、リードIDフィールドのサンプルデータはSampleLeadIDです。
  3. サンプルデータを編集して現実的な値を入力するか、サンプルデータの再生成をクリックすると、名前、住所、ID番号など、より現実的なサンプル値のセットが自動的に生成されます。
    ヒント: サンプルデータがテストするアクションのタイプに適切であることを確認してください。 IDやメールアドレスを使用してデータを取得する場合、サンプル・データはターゲット・アプリケーションに存在する有効なIDまたはメールアドレスを提供する必要があります。 あるいは、レコードを作成する場合、サンプルデータは、SampleEmailの代わりにabc@xyz.comの電子メールアドレスなど、ターゲットアプリケーションが特定のフィールドに要求する特別なフォーマットと一致しなければなりません。
  4. 提供されたサンプルデータでアクションをテストするには、テストアクションをクリックしてください。
    再生成されたサンプルデータは、Salesforce の "New lead "イベントで、Shopify で顧客を作成するために使用されます。

    アクションは、あなたの接続アカウントで一度完了します。 前の例では、Salesforceの新規リードのサンプルデータを使用して、Shopifyで顧客が作成されています。 アクションが完了すると、テスト結果の通知が表示されます。

    テスト成功時の結果通知
  5. アプリケーションから返されたテスト結果の詳細を見るには、View detailsをクリックして、テスト結果ペインを開きます。 このペインには入力と出力のタブがある。 結果は、出力タブに、作成または取得されたオブジェクトのフィールドの値のリストとして表示されます。 インプットタブはリクエストの内容を表示します。
    テスト結果ペインで、コードアイコンをクリックすると、テストのJSON出力が表示されます。 この出力をコピーするには、 コピーアイコン 「コピー」アイコン をクリックします。
    テスト成功時のJSON出力
    ヒント： すべてのプロパティがテスト結果ペインに表示されるわけではありません。 すべての入出力プロパティをJSON形式で表示するには、コード・ビューを使用します。

    ターゲット アプリケーションでトリガーされたアクションがエラーで失敗した場合、テスト通知にはテストが失敗したことが表示されます。 詳細を見るをクリックすると、エラーに関する詳細情報が表示されます。

サンプルデータを使ったフローのテスト

フロー内のすべてのノードを構成した後、サンプルデータを使用してターゲットアプリケーションに対するフローの効果をテストし、テスト結果を確認することができます。

このタスクについて

注意:この方法でアクションをテストすると、接続しているターゲットアプリケーションのアクションが完了します。 テストの前に、アクションの接続アカウントがテストに適切であることを確認する。 テスト用に1つのアカウントを使用し、フローをデプロイするときに別のアカウントを使用することができます。
イベントドリブンまたは API フローをテストするには、フロー内のアクションが適切なアカウント (Salesforce 開発者アカウントなど) に接続されていることを確認します。 そして、あなたのフローにバリデーションエラーがないことを確認してください。 これらの条件が満たされると、フローのステータスは次のようになるDraft (ready to deploy)そして、テストフローオプションがフローエディターで利用可能です。
ステータスがドラフト（配備準備完了）であり、使用可能なテストフローオプションを持つイベントドライブフロー。
制約事項:
  • バッチ処理ノードを含むフローはテストできません。
  • For eachノードを含むフローをテストする場合、ノードは受信した最初の3つのアイテムだけを処理します。

手順

フロー内のすべてのアクションをテストするには、以下の手順を実行する。

  1. テストしたいフローをApp Connect Designerで開きます.
    APIフローをテストしている場合は、APIフローを開き、該当する操作のフローの編集をクリックします。
    各API操作にはフロー編集ボタンがあり、その操作のフローを編集できます。
  2. フロー・エディターで、フロー内の各ノードに現実的なサンプル・データを指定します。 フロー内のアクションノードを選択し、サンプルデータをクリックします。
    Shopifyの顧客作成アクションのサンプルデータリンク。
    コンテキストとサンプルデータペインが開くと、フロー内の前の各ノードのフィールドを展開できます。 サンプルデータの初期セットはフィールドタイプによって異なる：
    • 文字列フィールドのサンプルデータ値は SampleFieldName です。
    • 整数フィールドの値は 1 です。
    • ブール値フィールドの値は true です。
    • 日付フィールドの値は1985-04-12T23:20:50.52Zです。
    コンテキストとサンプルデータ] ペインには、Salesforce の新規リードのフィールドのリストが表示されます。 各フィールドのサンプル値が表示されます。 例えば、リードIDフィールドのサンプルデータはSampleLeadIDです。
  3. サンプルデータを編集して現実的な値を入力するか、サンプルデータの再生成をクリックすると、名前、住所、ID番号など、より現実的なサンプル値のセットが自動的に生成されます。
    ヒント: サンプルデータがテストするアクションのタイプに適切であることを確認してください。 IDやメールアドレスを使用してデータを取得する場合、サンプル・データはターゲット・アプリケーションに存在する有効なIDまたはメールアドレスを提供する必要があります。 あるいは、レコードを作成する場合、サンプルデータは、SampleEmailの代わりにabc@xyz.comの電子メールアドレスなど、ターゲットアプリケーションが特定のフィールドに要求する特別なフォーマットと一致しなければなりません。
    フロー内の各ノードについてこのステップを繰り返す。
    次の例は、SalesforceからIDごとに連絡先の詳細を取得するAPIのシンプルなフローのRequestノードを示しています。 コンテキストとサンプルデータペインでは、CustomerIDリクエストパラメータのデフォルトのサンプルデータが、接続されているSalesforceインスタンスの実際のコンタクトIDで上書きされます。
    CustomerID のサンプル値は、Salesforce テストインスタンスの顧客の ID に置き換えられます。
    Salesforce Retrieve contacts アクションでは、ID 条件による取得を定義し、Request ノードのカスタムサンプル ID を使用して Salesforce を呼び出すことを示します。
    Salesforce 連絡先取得アクションに、連絡先 ID が顧客 ID と等しい連絡先を取得するという条件が追加されました。 CustomerIDはリクエストノードからマッピングされ、提供されたサンプルデータを示しています。

    Responseノードは、成功したレスポンスに対して返されるステータスコードとコンタクトデータを定義します。

  4. フロー内の全ノードのサンプルデータに満足したら、フローをテストする。
    • APIフローをテストする場合は、テストフローをクリックします。
      APIフローのテストフローボタン。
    • flow runsプランでイベントドリブンフローをテストしている場合は、「Test flow」をクリックする。
      フロー実行プランのイベント駆動フローのテストフローボタン。
    • プラン VPC hours をご利用中でイベント駆動型フローをテストする場合は、 [フローのテスト ] > [サンプルデータを使用] をクリックしてください。
      VPC時間プランでイベントドリブンフローをテストするためのテストフローメニュー。 メニューには、サンプルデータまたは実データを使用するオプションがあります。
  5. 接続しているアプリケーションがテストに適している場合は、テストをクリックします。
    サンプルデータを使用してフローをテストする場合、フローは一度実行され、接続されているアカウントのすべてのアクションを完了します。 フロー処理が完了すると、テスト結果の通知が表示される。
    テスト成功時の結果通知
  6. アプリケーションから返されたテスト結果の詳細を見るには、View detailsをクリックして、テスト結果ペインを開きます。 結果は出力タブに表示される。 インプットタブでリクエストの内容を見ることもできます。
    テスト結果の出力タブには、指定されたIDの顧客について取得された値が表示されます。
    テスト結果ペインで、コードアイコンをクリックすると、テストのJSON出力が表示されます。 この出力をコピーするには、 コピーアイコン 「コピー」アイコン をクリックします。
    テスト成功時のJSON出力
    ヒント： すべてのプロパティがテスト結果ペインに表示されるわけではありません。 すべての入出力プロパティをJSON形式で表示するには、コード・ビューを使用します。
    イベント・ドリブン・フローの場合、テストに成功すると、次のようなメッセージが表示されるThe flow test completed successfully.対象となるアプリケーションをチェックして、期待される結果が表示されることを確認することができます。
    イベント・ドリブン・フローの成功例
    ターゲットアプリケーションのトリガーされたアクションがエラーで失敗した場合、テスト通知は失敗した結果を表示し、詳細には詳細情報が表示されます。 次の例では、フローをテストするためにサンプル ID を生成しましたが、接続されている Salesforce インスタンスにそのコンタクト ID が存在しないため、失敗しました。
    フローのテスト失敗結果

実データを用いたイベントドリブンフローのテスト (VPC hours 計画のみ)

VPC hours プランでは、 フローエディターでイベントドリブンフローを一時的に実行し、デプロイ前にその動作を確認することができます。

開始前に

実際のデータでフローをテストすると、ロギング・メッセージが生成される。 これらのログメッセージは暗号化されておらず、 IBM によって保存される。 VPC hours プランでは、単一コンテナランタイムを有効にした場合、実データでテストするフローのロギングを無効にできます。 Instance settings（インスタンス設定） ページ インスタンス設定ページを表すアイコン に移動し、 Test flow logging（テストフローロギング） タブを開き、設定をオフにする。 この設定がオフの場合、ログ・ノードからのメッセージはログ・ ページに書き込まれません。 この設定をオンにする場合は、ログ・ノードが認証情報などの機密データを書き込んでいないことを確認してください。

このタスクについて

注意:この方法でフローをテストすると、接続しているターゲット アプリケーションのすべてのアクションが完了します。 テストの前に、アクションの接続アカウントがテストに適切であることを確認する。 テスト用に1つのアカウントを使用し、フローをデプロイするときに別のアカウントを使用することができます。
VPC hours プランをご利用の場合は、 フローエディターでフローを開始してテストすることができます。 ( flow runs プランをご利用の場合は、デプロイすることでフローを開始します）。 詳細については、 フロー実行プランでの統合の展開を参照してください) 実際のデータでフローをテストする場合、フローエディターでフローを実行中にソースアプリケーションが更新されると、フローがトリガーされます。 Stop testをクリックするまで、フローはアクティブなままです。
統合ランタイムの休止状態: Designer App Connect でフローをテストする場合、それらはデフォルトの統合ランタイムで実行され、インスタンスにログインしている間は実行を継続します。 ログアウトしてからしばらくすると、リソースを節約するためにデフォルトの統合ランタイムがハイバネートされ、App Connect Designer での開発フローが停止します。 再度ログインすると、デフォルトの統合ランタイムが再起動され、フローを再開することができます。
実際のデータを使用してイベント駆動フローをテストするには、フロー内のアクションが適切なアカウント (Salesforce 開発者アカウントなど) に接続されていることを確認します。 そして、あなたのフローにバリデーションエラーがないことを確認してください。 これらの条件が満たされると、フローのステータスは次のようになるDraft (ready to deploy)そして、テストフローオプションがフローエディターで利用可能です。
VPC時間プランでイベントドリブンフローをテストするためのテストフローメニュー。 メニューには、サンプルデータまたは実データを使用するオプションがあります。

手順

実際のデータを使ってフローをテストするには、以下のステップを完了する。

  1. App Connect Designerでテストするフローを開き、［ Test flow］ > ［Using real data ］をクリックします。
    または、Designerダッシュボードのフロータイルでメニューを開き、実データを使用してテストをクリックします。
  2. 接続しているアプリケーションがテストに適している場合は、テストをクリックします。
    フローのステータスはPreparing to testフローがデフォルトの統合ランタイムに一時的にデプロイされている間。 フローがテストできる状態になると、ステータスは次のように変わるTesting.
  3. フローのソース・アプリケーションで、フローをトリガーするイベント・アクティビティを完了します。
    たとえば、次のフローをトリガするには、Salesforce インスタンスに、Salesforce Account 1 にリンクされているコンタクトを作成します。
    シンプルなフローには、Salesforce New contact イベントと Asana Create task アクションが含まれます。 Salesforce コネクタは Salesforce アカウント 1 に接続され、Asana コネクタは Asana アカウント 1 に接続されています。
    ヒント：
    • アプリケーションの本番アカウントを使用せずにフローをテストするには、フロー内のイベントとアクションにテストアカウントを設定します。
    • トリガーイベントを完了させなくても、フロー内の一連のアクションをテストすることができる。 フロー内のイベントを一時的にスケジューラーイベントに置き換え、最初にスイッチを入れたときにもフローを実行するを選択します。

    実データを使ってフローをテストする場合、フローはアクティブのまま、イベントがトリガーするたびに実行される。 フローは、接続されたアカウントのすべてのアクションを完了します。

  4. ターゲット・アプリケーションを調べて、予想される結果が表示されていることを確認してください。
    たとえば、Asana インスタンスをチェックして、新しい Salesforce コンタクトに関連するアクションを処理するタスクが作成されていることを確認します。

    ストリーム・イベントがフローをトリガーする場合、アプリケーションに対するアクションは、フローがトリガーされた直後に完了する。 ポーリングされたイベントまたはスケジューラ・イベントがフローをトリガーすると、設定されたスケジュールに従ってアプリケーションのアクションが完了する。

  5. フローのテストが終わったら、テスト中止をクリックします。
    フローのステータスはDraft (ready to deploy).

APIのテスト (VPC hours 計画)

APIフローを作成すると、定義によって呼び出せるAPIが提供される。 オンザ VPC hours 計画では、組み込みのテスト機能を使用して各 API 操作のエンドポイントを呼び出すことにより、API の動作を検証します。

このタスクについて

注意:この方法でAPIをテストすると、接続しているターゲットアプリケーションのアクションが完了します。 テストの前に、アクションの接続アカウントがテストに適切であることを確認する。 テスト用に1つのアカウントを使用し、フローをデプロイするときに別のアカウントを使用することができます。

VPC hours プランをご利用の場合、 デプロイ前にフローエディターでAPIをテストすることができます。 APIそのものではなく、API操作を実装するフローをテストするためにサンプルデータを使用することもできます。 詳細については、 サンプルデータを使ったフローのテストを参照してください。

API をテストするには、すべての操作にフローがあり、フロー内のアクションが適切なアカウント (Salesforce 開発者アカウントなど) に接続されていることを確認します。 そして、あなたのフローにバリデーションエラーがないことを確認してください。 これらの条件が満たされると、フローのステータスは次のようになるDraft (ready to deploy)そして、テストAPIオプションがフローエディターで利用可能です。
VPC時間プランでAPIをテストするためのTest APIメニュー。
APIをテストすると、Stop testをクリックするまで、APIはアクティブなままです。
注意: App Connect Designer でフローをテストする場合、フローはデフォルトの統合ランタイムで実行され、インスタンスにログインしている間も実行されます。 ログアウトしてからしばらくすると、リソースを節約するためにデフォルトの統合ランタイムがハイバネートされ、App Connect Designer での開発フローが停止します。 再度ログインすると、デフォルトの統合ランタイムが再起動され、フローを再開することができます。

手順

APIをテストするには、以下の手順を実行する。

  1. App Connect デザイナーでテストしたいAPIを開き、テストAPIをクリックします。
    または、Designerダッシュボードのフロータイルでメニューを開き、Test APIをクリックします。
  2. 接続しているアプリケーションがテストに適している場合は、テストをクリックします。
    APIのステータスはPreparing to testフローがデフォルトの統合ランタイムに一時的にデプロイされている間。 APIをテストする準備ができたら、ステータスは次のように変わるTestingそしてテストタブが利用できる。
  3. テストタブをクリックします
    概要ページには、APIタイプ、プロトコル、APIエンドポイントのベース URL、セキュリティスキームが表示される。 フローをテストしたときにAPIが自動的に API Connect インスタンスに自動的に公開された場合、APIエンドポイントは API Connect. (詳細については、 APIのフローをゼロから作成するを参照) それ以外の場合は、 App Connect Designerのデプロイメントによってエンドポイントが提供されます。
    APIテストタブの概要ページ
    API endpointがApp Connectから供給される場合、APIがデプロイされているかテスト中かによってエンドポイントは異なります。
    • APIをテストするとき、APIはデフォルトの統合ランタイムに一時的にデプロイされる。 したがって、APIエンドポイントはhttps://default-integration-runtimeで始まる：
      https://default-integration-runtime-https-ac0abcd2def.p-vir-d1.appconnect.ibmappdomain.cloud/Bookstore_API
    • APIをデプロイすると、APIは作成したランタイムにデプロイされる。 したがって、APIエンドポイントはランタイムの名前で始まる：
      https://my-custom-ir-https-ac0abcd2def.p-vir-d1.appconnect.ibmappdomain.cloud/Bookstore_API
    TestタブにはFilterメニューがあり、APIフローに実装されている操作とモデル定義が一覧表示されます。 フィルターメニューを使って、操作のラベルの付け方やグループ分けを変更することができます。 (モデル名で操作をグループ化することができる）
    Filter（フィルター）メニューには、パス、名前、サマリーで操作を表示するオプションがあります。

    各操作をクリックすると詳細が表示され、動作をテストできます。 表示されるタグは、操作が属するモデルを識別する。

    各操作について、詳細タブには以下の情報が表示されます。
    • 操作の HTTP メソッドおよび要求。
    • API が使用する認証方式 (セキュリティー・スキーム)。
    • 省略表示可能なセクションのヘッダー・パラメーター。
    • 本文、パス、または照会パラメーターの例、および関連する場合はスキーマ (折りたたみ可能なセクションで表示)。 表示されるパラメーターは、操作の設定によって異なります。
      セキュリティの仕組み、API操作の HTTP リクエストとパラメータ
    • リクエスト時に使用できる言語と、選択した言語で操作を呼び出すためのコードサンプル。
    • 操作の応答状況コード、および例を持つ応答本体スキーマ。
      ツール言語によるリクエストとAPI操作のレスポンスのサンプル
      また、定義をクリックし、各セクションを展開すると、各モデルのスキーマ定義と例を見ることができます。
      APIモデルの定義
  4. API操作をテストするには、操作を選択し、試してみるタブに移動します。
    生成されたセキュリティ認証情報とリクエストパラメータが表示されます。
    ユニファイド・オーサリングが有効な場合、セキュリティセクションは、クライアントIDセキュリティ・スキームが、APIのリクエスト・ヘッダに認証情報を渡すためのX-IBM-Client-Idパラメータとともに使用されることを示します。
    共著APIのサンプルPOST操作のセキュリティ認証情報と HTTP パラメータ
    詳細タブのリクエスト例セクションにある提供されたコードサンプルのいずれかを使用して操作を呼び出すには、リクエストにクライアントID値を含めます。 このクライアントIDはApp Connect Designerインスタンスでは表示されないため、API Connectインスタンスから取得する必要があります。 API Manager UIから、APIが公開されたサンドボックスまたはユーザー定義カタログを開きます。 次に、アプリケーションタブをクリックしてクライアントIDを表示し、コピーします。
    サンドボックスカタログのアプリケーションタブからクライアントIDを取得する

    ユニファイド・オーサリングが有効になっていない場合、セキュリティ・スキームには基本認証が使用される。 詳細タブのリクエスト例セクションにある提供されたコードサンプルのいずれかを使用して、操作を呼び出すことができます。 表示されたユーザー名とパスワードをコピーして、リクエストのAuthorizationヘッダーで使用する。

    例えば、Authorization: Basic REPLACE_BASIC_AUTH などです。 REPLACE_BASIC_AUTH 値は通常、username:password の Base64 エンコード値です。
    サンプル POST 操作のセキュリティ認証情報と HTTP パラメータ
  5. Parametersセクションで、Generateをクリックしてサンプルデータを生成するか、独自のデータを指定して、リクエストに渡すテストデータを指定します。 必要なデータは、手術の種類や定義によって異なる。
    • POST 操作の場合、本体または照会パラメーターのサンプル・データを生成できます。 あるいは、操作の本体または照会スキーマに準拠するデータを手動で指定できます。
    • GET操作では、クエリ・パス・パラメータを指定できる。 また、ターゲット・アプリケーションから取得しようとしているデータを一意に識別するために、既存の有効なIDやその他の値を指定する必要があるかもしれない。
    • PUT 操作の場合、パスまたは本体のパラメーターを指定できます。
    次の例では、Salesforceで商品(書籍)を作成するPOST操作に対して、生成されたサンプルデータをJSON形式で示しています。
    ブックモデルに対するPOST操作の完了したTry itタブ。 サンプルデータを用いてJSON形式のボディパラメータを生成します。 ISBN、タイトル、著者、出版日、ジャンルについてテスト値が生成される。
  6. 送信をクリックしてAPIオペレーションを呼び出し、表示されるリクエストとレスポンスを確認します。
    次の例は、Salesforceに顧客を作成するPOST操作のリクエストとレスポンスを示しています。 レスポンスには、返される成功コード (201 Created) 、ヘッダー、および Salesforce が割り当てるコンタクト ID を表す CustomerID 値が含まれます。
    APIコールのサンプル・レスポンス
  7. 操作に関係がある場合は、ターゲット・アプリケーションで予期される結果を確認してください。
  8. APIのテストが終わったら、テスト中止をクリックします。
    APIのステータスはDraft (ready to deploy).