開発者ポータル ・テスト・ツールを使用した API のテスト

開発者ポータル のテスト・ツールを使用することで、コードを作成することなく API の動作をテストできます。 必要な API パラメーターをテスト・ツール内で指定し、「起動」をクリックして応答を表示します。

開始前に

アプリケーション・クライアント ID を必要とする API で 開発者ポータル ・テスト・ツールを使用するには、まず以下のタスクを実行する必要があります。

このタスクについて

開発者ポータル ・テスト・ツールは、対話式の API 文書テスト・ツールです。 テストする操作にクライアント ID が必要ない場合は、サインインしなくても 開発者ポータル のテスト・ツールを使用できます。 ただし、対話する操作でクライアント ID が必要な場合は、まず 開発者ポータル にサインインする必要があります。

開発者ポータル ・テスト・ツールの使用には、操作またはプランに適用されるレート制限が適用されます。 例えば、ある操作のレート制限が 1 分あたり 10 個の要求である場合、その操作を呼び出すと、実行可能な要求の数が 9 個に減ります。 その 1 分の間隔内に「呼び出し」をクリックするたびに、制限がトリガーされます。 この注意事項は、 開発者ポータル のテスト・ツールで使用するために選択されたアプリケーションの割り当て量に影響しますが、同じ操作またはプランを使用している他のアプリケーションの割り当て量には影響しません。

開発者ポータルで API をテストするには、 「API Manager」で 「この API のテストを許可」 チェック・ボックスを選択する必要があります。 詳しくは、 API 定義の作成を参照してください。

制約事項:
  • 開発者ポータル のテスト・ツールを使用して OAuth プロバイダー API の「暗黙」または「許可コード」権限付与タイプをテストすることを妨げるセキュリティー・メカニズムがあります。 同じ OAuth プロバイダー API の他の権限付与タイプについては、テストできます。 テスト・ツールで当該アクションが正しく機能するように OAuth プロバイダーが構成されていれば、このオプションは無効にできます。 詳しくは、 テスト・ツールの制限の無効化を参照してください。
  • 中断状態のアプリケーションで 開発者ポータル ・テスト・ツールを使用することはできません。
  • 強制されない API をテストできるのは、testable=true であり、かつ既存の API が CORS を実装して HTTPS を使用している場合のみです。
注: GraphQL API は、 開発者ポータル のユーザー・インターフェースからテストできます。 ただし、すべての認証方式がサポートされているわけではありません。 以下の認証方式のいずれかを使用する必要があります。
  • 無保護
  • ヘッダーで渡されたクライアント ID
  • ヘッダーで渡されたクライアント ID と秘密鍵
また、cost メトリックはサポートされず、GraphQL に固有のレート制限は製品プランにリストされません。

手順

  1. アプリケーションのクライアント ID を必要としない API で 開発者ポータル ・テスト・ツールを使用するには、以下の手順を実行します。
    1. 「API 製品」をクリックします。
      アプリケーション開発者が使用できるすべての API が表示されます。
    2. テストする API の名前をクリックします。
    3. 操作を選択してから、 「試行する (Try It)」を選択します。
    4. 「この操作を試す」をクリックします。
    5. 必要なヘッダーまたはパラメーターの値を入力します。
    6. 操作が基本認証で保護されている場合は、資格情報を指定します。
    7. 「要求の送信」をクリックします。
      「応答の本文」フィールドに結果が表示されます。 必要に応じて、さまざまなパラメーター値のテストを続行することができます。
      注:

      初めて「試してみる」をクリックすると、セキュリティー・エラーが表示される場合があります。 「要求 URL (Request URL)」フィールドから URL をコピーし、それをブラウザー・ウィンドウで開き、セキュリティー証明書を受け入れます。 再びセキュリティー・エラーが表示されることはありません。

      また、パフォーマンス上の理由から、ペイロードが大きい (DOM で強調表示されたエレメントが 1500 個を超える) 場合は、応答を受け取っても整形して出力されません。

  2. アプリケーションのクライアント ID を必要とする API で 開発者ポータル ・テスト・ツールを使用するには、以下の手順を実行します。
    1. 開発者ポータルにサインインします。
    2. アプリケーションをまだ作成していない場合は作成し、クライアント ID を必要とする API をテストできるようにする必要があります。 詳しくは、 アプリケーションの登録を参照してください。
    3. テストする API を含むプランをアプリケーションがサブスクライブしていることを確認します。 詳しくは、 開発者ポータルでの API および製品の探索を参照してください。
    4. 「API 製品」をクリックします。
      アプリケーション開発者が使用できるすべての API が表示されます。
    5. テストする API をクリックします。
    6. Provide credentials for Client ID (API Key) 操作を選択してから、 「試行する (Try It)」を選択します。
      「API 鍵の識別」ウィンドウが表示されます。
    7. 「クライアント ID を選択するためにアプリケーションを登録する」 ドロップダウン・リストを使用して、API をテストするアプリケーションを選択します。
    8. 「資格情報の保存」をクリックします。
    9. クライアント秘密鍵が必要な場合は、 「クライアント秘密鍵」 フィールドに値を入力します。
    10. テストする操作を見つけて、 「試行する (Try It)」をクリックします。
    11. 必要なパラメーターおよび値を入力します。
    12. 操作が基本認証で保護されている場合は、資格情報を指定します。
    13. 「送信」をクリックします。
      「応答」セクションに結果が表示されます。 必要に応じて、さまざまなフィールド値のテストを続行することができます。
      注: 「呼び出し」を初めてクリックしたときに、セキュリティー・エラーが表示されることがあります。 示されたリンクをクリックして、セキュリティー証明書を受け入れます。 再びセキュリティー・エラーが表示されることはありません。